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
The main aim of the **Biscuit project**, when it started off was to break down the complex processes behind popular code editors that power today, and develop a comparable tool that is as capable, efficient, and well-optimized as the existing ones. The current codebase of Biscuit is written in **pure Python** and draws a lot of inspiration from esteemed code editors like Visual Studio Code, Atom, and Emacs.
11
-
12
-
Our project also aims to foster a vibrant open-source community of Python enthusiasts and software developers, working together to create a truly innovative tool. With invaluable contributions from passionate collaborators, Biscuit has made significant progress in incorporating essential features such as syntax highlighting, autocompletion, and Git integration.
12
+
🚀<b>A</b> magnificent project that brings together the best elements of eminent code editors while adding its own unique flair. Compact, yet compelling; comprehensive, yet concise – Biscuit has set its sights on conquering the realm of code editing, capturing the hearts of developers and enthusiasts alike. Biscuit is here to reshape your coding universe!
13
+
<br><br>
14
+
❤ <b>Our</b> project aims to foster a vibrant open-source community of Python enthusiasts, working together to create a truly innovative tool. With invaluable contributions from passionate collaborators, Biscuit has made significant progress in incorporating essential features such as syntax highlighting, autocompletion, and Git integration.
You can download the latest compiled pre-release of Biscuit for Windows and Linux from [Releases](https://github.com/billyeatcookies/Biscuit/releases)!
25
+
26
+
### 🛠 Building from Source
27
+
The project is a WIP. Bugs and missing or incomplete features will be present in the current unreleased version.
28
+
> **Note**
29
+
> You need **python 3.10** or above.
30
+
31
+
Download the project source or clone this repo, in the project directory run:
23
32
```bash
24
33
> pip install -r requirements.txt
25
34
> python -m biscuit
26
35
```
27
-
If you use **poetry**, this will get biscuit up and running
28
-
```bash
29
-
> poetry install
30
-
> python -m biscuit
31
-
```
36
+
To run in a separate virtual environment, you can use [python poetry](https://python-poetry.org/).
37
+
To compile Biscuit for your platform, see [compiling guide](https://github.com/billyeatcookies/Biscuit/tree/main/scripts).
32
38
33
39
> **Note**
34
40
> If you are getting an error during installation in **Linux**, install following dependencies and try again:
@@ -37,18 +43,21 @@ If you use **poetry**, this will get biscuit up and running
37
43
>> pip install scikit-build
38
44
>```
39
45
40
-
## Contributors
41
-
To contribute to the biscuit project, check our [contributing guidelines](./CONTRIBUTING.md). Your contributions and support are greatly appreciated! 🧡
46
+
47
+
## ❤ Contributors
48
+
Our project aims to foster a vibrant open-source community of Python enthusiasts, your contributions and support are greatly appreciated! 🧡 check our [contributing guidelines](./CONTRIBUTING.md) for any questions!
0 commit comments