Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 37 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,7 @@ Bridgex is an open‑source graphical interface for converting files to Markdown

---

## Table of Contents

- [Bridgex 🌉🐍](#bridgex-)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Local Cloning and Execution 💻](#local-cloning-and-execution-)
- [Basic Usage](#basic-usage)
- [Supported Formats](#supported-formats)
- [Limitations](#limitations)
- [Releases](#releases)
- [Dependencies and Licences](#dependencies-and-licences)
- [Contribute](#contribute)
- [Licence](#licence)

---

## Features
## Features ✨

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

---

## Screenshots
## Screenshots 🖼️

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

---

## Installation
## Installation 📦

Requirements:

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

Clone the repository and run Bridgex locally:

1. Clone the repository.

```sh
git clone https://github.com/Dev2Forge/bridgex.git
```

2. Navigate to the project directory and set up a virtual environment.
```sh
cd bridgex
```
3. Create a virtual environment.

```sh
python -m venv .venv
.venv\Scripts\activate # On Windows
```

4. Activate the virtual environment.

```sh
# On Windows
.venv\Scripts\activate
# source .venv/bin/activate # On Linux/MacOS
```

5. Install the required dependencies.

```sh
pip install -r requirements.txt
```

6. Run the application.

```sh
python -m src.bridgex
```

---

## Basic Usage
## Basic Usage 🚀

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

---

## Supported Formats
## Supported Formats 📂

Bridgex supports conversion of the following file formats:

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

---

## Limitations
## Limitations ⚠️

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.

---

## Releases
## Releases 🏷️

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

---

## Dependencies and Licences
## Dependencies and Licences 📚

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.

---

## Contribute
## Contribute 🤝

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

---

## Licence
## Licence 📄

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

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"

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

classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: End Users/Desktop",
"Intended Audience :: Developers",
"Topic :: Utilities",
Expand Down
4 changes: 2 additions & 2 deletions src/bridgex/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from ._bridgex import Bridgex

__author__:str = "Tutos Rive"
__version__:str = "0.0.1-dev"
__version__:str = "0.0.3-dev"
__license__:str = "MIT"
__description__:str = "Bridgex is a PySide6 application for file management and conversion, featuring a lite markdown editor and viewer."
__description__:str = "Graphical interface for converting files to Markdown, built in Python and based on PySide6 and Markitdown."
__all__:list[str] = ['FileManager', 'Converter', 'Bridgex', '__author__', '__version__', '__license__', '__description__']
2 changes: 1 addition & 1 deletion src/bridgex/interface/translations/others/ABOUT_en_GB.trg
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pre{line-height: 1 !important; font-size: 15px;}
</div>
<hr>
<div>
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.1.0 - Beta</pre>
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.0.3-dev</pre>
<table style="margin-top: 10px" align="center" width="60%">
<tr>
<td><pre class="center"><a href="https://github.com/Dev2Forge/bridgex">Website</a></pre></td>
Expand Down
2 changes: 1 addition & 1 deletion src/bridgex/interface/translations/others/ABOUT_es_CO.trg
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pre{line-height: 1 !important; font-size: 15px;}
</div>
<hr>
<div>
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.1.0 - Beta</pre>
<pre class="center" style="line-height: 0.7 !important">Bridgex V0.0.3-dev</pre>
<table style="margin-top: 10px" align="center" width="60%">
<tr>
<td><pre class="center"><a href="https://github.com/Dev2Forge/bridgex">Sitio Web</a></pre></td>
Expand Down
30 changes: 29 additions & 1 deletion translations/README_ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,41 @@ Se recomienda el uso de un entorno virtual. Para personalizar los formatos sopor

Clona el repositorio y ejecuta Bridgex localmente:

1. Clona el repositorio.

```sh
git clone https://github.com/Dev2Forge/bridgex.git
```

2. Navega al directorio del proyecto y configura un entorno virtual.

```sh
cd bridgex
```

3. Crea un entorno virtual.

```sh
python -m venv .venv
.venv\Scripts\activate # En Windows
```

4. Activa el entorno virtual.

```sh
# En Windows
.venv\Scripts\activate
# source .venv/bin/activate # En Linux/MacOS
```

5. Instala las dependencias requeridas.

```sh
pip install -r requirements.txt
```

6. Ejecuta la aplicación.

```sh
python -m src.bridgex
```

Expand Down