Skip to content

Commit 56f30a7

Browse files
authored
Merge pull request #25 from Dev2Forge/develop
Update dev version in files
2 parents 85fc581 + 0f0832b commit 56f30a7

6 files changed

Lines changed: 73 additions & 37 deletions

File tree

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,7 @@ Bridgex is an open‑source graphical interface for converting files to Markdown
1111

1212
---
1313

14-
## Table of Contents
15-
16-
- [Bridgex 🌉🐍](#bridgex-)
17-
- [Table of Contents](#table-of-contents)
18-
- [Features](#features)
19-
- [Screenshots](#screenshots)
20-
- [Installation](#installation)
21-
- [Local Cloning and Execution 💻](#local-cloning-and-execution-)
22-
- [Basic Usage](#basic-usage)
23-
- [Supported Formats](#supported-formats)
24-
- [Limitations](#limitations)
25-
- [Releases](#releases)
26-
- [Dependencies and Licences](#dependencies-and-licences)
27-
- [Contribute](#contribute)
28-
- [Licence](#licence)
29-
30-
---
31-
32-
## Features
14+
## Features ✨
3315

3416
* Cross‑platform graphical interface.
3517
* Efficient file‑to‑Markdown conversion.
@@ -39,7 +21,7 @@ Bridgex is an open‑source graphical interface for converting files to Markdown
3921

4022
---
4123

42-
## Screenshots
24+
## Screenshots 🖼️
4325

4426
![img](https://cdn.jsdelivr.net/gh/tutosrive/images-projects-srm-trg@main/dev2forge/pymd/bridgex/preview-1-main.png)
4527
*Example of Bridgex’s main window.*
@@ -60,7 +42,7 @@ Bridgex is an open‑source graphical interface for converting files to Markdown
6042

6143
---
6244

63-
## Installation
45+
## Installation 📦
6446

6547
Requirements:
6648

@@ -86,19 +68,45 @@ It is recommended to use a virtual environment. To customise supported formats,
8668

8769
Clone the repository and run Bridgex locally:
8870

71+
1. Clone the repository.
72+
8973
```sh
9074
git clone https://github.com/Dev2Forge/bridgex.git
75+
```
76+
77+
2. Navigate to the project directory and set up a virtual environment.
78+
```sh
9179
cd bridgex
80+
```
81+
3. Create a virtual environment.
82+
83+
```sh
9284
python -m venv .venv
93-
.venv\Scripts\activate # On Windows
85+
```
86+
87+
4. Activate the virtual environment.
88+
89+
```sh
90+
# On Windows
91+
.venv\Scripts\activate
9492
# source .venv/bin/activate # On Linux/MacOS
93+
```
94+
95+
5. Install the required dependencies.
96+
97+
```sh
9598
pip install -r requirements.txt
99+
```
100+
101+
6. Run the application.
102+
103+
```sh
96104
python -m src.bridgex
97105
```
98106

99107
---
100108

101-
## Basic Usage
109+
## Basic Usage 🚀
102110

103111
1. Run the application from the terminal or GUI.
104112
2. Select the file to convert.
@@ -107,7 +115,7 @@ python -m src.bridgex
107115

108116
---
109117

110-
## Supported Formats
118+
## Supported Formats 📂
111119

112120
Bridgex supports conversion of the following file formats:
113121

@@ -129,31 +137,31 @@ Bridgex supports conversion of the following file formats:
129137

130138
---
131139

132-
## Limitations
140+
## Limitations ⚠️
133141

134142
Bridgex is not an IDE, text editor, Markdown editor, or document viewer. Its purpose is to serve as a bridgex between the user and Markdown conversion, offering lightweight editing without advanced editing features.
135143

136144
---
137145

138-
## Releases
146+
## Releases 🏷️
139147

140148
Check the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridgex/releases) section of the repository.
141149

142150
---
143151

144-
## Dependencies and Licences
152+
## Dependencies and Licences 📚
145153

146154
This project uses third‑party libraries, each with its own licence. See the [third‑party](https://github.com/Dev2Forge/bridgex/tree/main/third-party/) folder for more information.
147155

148156
---
149157

150-
## Contribute
158+
## Contribute 🤝
151159

152160
Contributions are welcome. Please open an issue or pull request following the community’s best practices.
153161

154162
---
155163

156-
## Licence
164+
## Licence 📄
157165

158166
Distributed under the [MIT Licence](https://github.com/Dev2Forge/bridgex/blob/main/LICENSE).
159167

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "bridgex"
7-
version = "0.0.1-dev"
8-
description = "graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown"
7+
version = "0.0.3-dev"
8+
description = "Graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown."
99
readme = { file = "README.md", content-type = "text/markdown", charset = "utf-8" }
1010
license = "MIT"
1111
authors = [{ name = "dev2forge", email = "bridgex@dev2forge.software" }]
@@ -46,7 +46,7 @@ dependencies = [
4646
requires-python = ">=3.9,<=3.13"
4747

4848
classifiers = [
49-
"Development Status :: 3 - Alpha",
49+
"Development Status :: 4 - Beta",
5050
"Intended Audience :: End Users/Desktop",
5151
"Intended Audience :: Developers",
5252
"Topic :: Utilities",

src/bridgex/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from ._bridgex import Bridgex
44

55
__author__:str = "Tutos Rive"
6-
__version__:str = "0.0.1-dev"
6+
__version__:str = "0.0.3-dev"
77
__license__:str = "MIT"
8-
__description__:str = "Bridgex is a PySide6 application for file management and conversion, featuring a lite markdown editor and viewer."
8+
__description__:str = "Graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown."
99
__all__:list[str] = ['FileManager', 'Converter', 'Bridgex', '__author__', '__version__', '__license__', '__description__']

src/bridgex/interface/translations/others/ABOUT_en_GB.trg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pre{line-height: 1 !important; font-size: 15px;}
6565
</div>
6666
<hr>
6767
<div>
68-
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.1.0 - Beta</pre>
68+
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.0.3-dev</pre>
6969
<table style="margin-top: 10px" align="center" width="60%">
7070
<tr>
7171
<td><pre class="center"><a href="https://github.com/Dev2Forge/bridgex">Website</a></pre></td>

src/bridgex/interface/translations/others/ABOUT_es_CO.trg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pre{line-height: 1 !important; font-size: 15px;}
6565
</div>
6666
<hr>
6767
<div>
68-
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.1.0 - Beta</pre>
68+
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.0.3-dev</pre>
6969
<table style="margin-top: 10px" align="center" width="60%">
7070
<tr>
7171
<td><pre class="center"><a href="https://github.com/Dev2Forge/bridgex">Sitio Web</a></pre></td>

translations/README_ES.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,41 @@ Se recomienda el uso de un entorno virtual. Para personalizar los formatos sopor
8080

8181
Clona el repositorio y ejecuta Bridgex localmente:
8282

83+
1. Clona el repositorio.
84+
8385
```sh
8486
git clone https://github.com/Dev2Forge/bridgex.git
87+
```
88+
89+
2. Navega al directorio del proyecto y configura un entorno virtual.
90+
91+
```sh
8592
cd bridgex
93+
```
94+
95+
3. Crea un entorno virtual.
96+
97+
```sh
8698
python -m venv .venv
87-
.venv\Scripts\activate # En Windows
99+
```
100+
101+
4. Activa el entorno virtual.
102+
103+
```sh
104+
# En Windows
105+
.venv\Scripts\activate
88106
# source .venv/bin/activate # En Linux/MacOS
107+
```
108+
109+
5. Instala las dependencias requeridas.
110+
111+
```sh
89112
pip install -r requirements.txt
113+
```
114+
115+
6. Ejecuta la aplicación.
116+
117+
```sh
90118
python -m src.bridgex
91119
```
92120

0 commit comments

Comments
 (0)