You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
2. Navigate to the project directory and set up a virtual environment.
78
+
```sh
91
79
cd bridgex
80
+
```
81
+
3. Create a virtual environment.
82
+
83
+
```sh
92
84
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
94
92
# source .venv/bin/activate # On Linux/MacOS
93
+
```
94
+
95
+
5. Install the required dependencies.
96
+
97
+
```sh
95
98
pip install -r requirements.txt
99
+
```
100
+
101
+
6. Run the application.
102
+
103
+
```sh
96
104
python -m src.bridgex
97
105
```
98
106
99
107
---
100
108
101
-
## Basic Usage
109
+
## Basic Usage 🚀
102
110
103
111
1. Run the application from the terminal or GUI.
104
112
2. Select the file to convert.
@@ -107,7 +115,7 @@ python -m src.bridgex
107
115
108
116
---
109
117
110
-
## Supported Formats
118
+
## Supported Formats 📂
111
119
112
120
Bridgex supports conversion of the following file formats:
113
121
@@ -129,31 +137,31 @@ Bridgex supports conversion of the following file formats:
129
137
130
138
---
131
139
132
-
## Limitations
140
+
## Limitations ⚠️
133
141
134
142
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.
135
143
136
144
---
137
145
138
-
## Releases
146
+
## Releases 🏷️
139
147
140
148
Check the published versions and release notes in the [Releases](https://github.com/Dev2Forge/bridgex/releases) section of the repository.
141
149
142
150
---
143
151
144
-
## Dependencies and Licences
152
+
## Dependencies and Licences 📚
145
153
146
154
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.
147
155
148
156
---
149
157
150
-
## Contribute
158
+
## Contribute 🤝
151
159
152
160
Contributions are welcome. Please open an issue or pull request following the community’s best practices.
153
161
154
162
---
155
163
156
-
## Licence
164
+
## Licence 📄
157
165
158
166
Distributed under the [MIT Licence](https://github.com/Dev2Forge/bridgex/blob/main/LICENSE).
0 commit comments