Skip to content

Commit 1ef5df8

Browse files
authored
Merge pull request #96 from billyeatcookies/billyeatcookies-patch-1
Improve README
2 parents c219c36 + 47fb84c commit 1ef5df8

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,38 @@
33
The uncompromising code editor<br><br>
44
<img src=https://forthebadge.com/images/badges/made-with-python.svg height=28>
55
<img alt="Project License" src="https://img.shields.io/github/license/billyeatcookies/Biscuit?style=for-the-badge">
6-
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/billyeatcookies/Biscuit?style=for-the-badge">
6+
<a href=https://github.com/billyeatcookies/Biscuit/releases>
7+
<img alt="Download Latest" src="https://img.shields.io/github/v/release/billyeatcookies/biscuit?style=for-the-badge">
8+
</a>
79
<img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/billyeatcookies/Biscuit?style=for-the-badge">
810
</h2>
911

10-
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.
1315

1416
<h1></h1>
1517
<h3>
16-
<img src=https://github.com/billyeatcookies/Biscuit/assets/70792552/0e596550-22fe-42bc-a4e7-7e028155387a />
17-
<img src=https://github.com/billyeatcookies/Biscuit/assets/70792552/ce31691d-a45d-442c-9f54-16cebe02ef7a />
18+
<img src=https://github.com/billyeatcookies/Biscuit/assets/70792552/cb7c2cb2-f595-4708-b4cd-f75dcf481313 />
1819
</h3>
1920

20-
## Running biscuit 💿
21-
This project is a WIP. Bugs and missing or incomplete features will be present.
22-
You need **python 3.10** or above.
21+
## 💿 Installing Biscuit
22+
[![GitHub release (with filter)](https://img.shields.io/github/v/release/billyeatcookies/biscuit?style=for-the-badge)](https://github.com/billyeatcookies/Biscuit/releases)
23+
24+
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:
2332
```bash
2433
> pip install -r requirements.txt
2534
> python -m biscuit
2635
```
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).
3238

3339
> **Note**
3440
> 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
3743
> > pip install scikit-build
3844
> ```
3945
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!
4249
4350
<a href="https://github.com/billyeatcookies/biscuit/graphs/contributors">
4451
<img src="https://opencollective.com/biscuit/contributors.svg?width=890" />
4552
</a>
4653
47-
## Screenshots ✨
48-
![python_s8THu31T0Q](https://github.com/billyeatcookies/Biscuit/assets/70792552/032fac52-3f2f-4b1e-8908-a7b7c42aee13)
49-
![python_k6yohhbuck](https://github.com/billyeatcookies/Biscuit/assets/70792552/e34ae3ca-7767-4210-a446-41a517af0e76)
54+
## 📸 Screenshots
55+
![python_33z3mLyKaj](https://github.com/billyeatcookies/Biscuit/assets/70792552/acb36423-65f3-46a0-b4a0-9e381b5d1995)
56+
![python_fOxALHL7iv](https://github.com/billyeatcookies/Biscuit/assets/70792552/db279b28-859a-4376-a60e-10890235c729)
57+
![python_haGYWbGzcX](https://github.com/billyeatcookies/Biscuit/assets/70792552/9e75f2c2-6a24-43e4-a3a2-fcaa1728d18c)
58+
![python_MolICK4FSV](https://github.com/billyeatcookies/Biscuit/assets/70792552/6875cb5c-627c-4bae-9fcc-2a15d2a4b2ce)
5059
51-
## Features
60+
## Features
5261
- **Palette** which works based on various prompts used
5362
(`Ctrl` + `shift` + `p` for command palette)
5463

0 commit comments

Comments
 (0)