Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlin7 committed Jul 29, 2023
2 parents 4c67314 + 1ef5df8 commit 8caa59a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 21 deletions.
49 changes: 29 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,38 @@
The uncompromising code editor<br><br>
<img src=https://forthebadge.com/images/badges/made-with-python.svg height=28>
<img alt="Project License" src="https://img.shields.io/github/license/billyeatcookies/Biscuit?style=for-the-badge">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/billyeatcookies/Biscuit?style=for-the-badge">
<a href=https://github.com/billyeatcookies/Biscuit/releases>
<img alt="Download Latest" src="https://img.shields.io/github/v/release/billyeatcookies/biscuit?style=for-the-badge">
</a>
<img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/billyeatcookies/Biscuit?style=for-the-badge">
</h2>

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.

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.
🚀<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!
<br><br>
❤ <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.

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

## Running biscuit 💿
This project is a WIP. Bugs and missing or incomplete features will be present.
You need **python 3.10** or above.
## 💿 Installing Biscuit
[![GitHub release (with filter)](https://img.shields.io/github/v/release/billyeatcookies/biscuit?style=for-the-badge)](https://github.com/billyeatcookies/Biscuit/releases)

You can download the latest compiled pre-release of Biscuit for Windows and Linux from [Releases](https://github.com/billyeatcookies/Biscuit/releases)!

### 🛠 Building from Source
The project is a WIP. Bugs and missing or incomplete features will be present in the current unreleased version.
> **Note**
> You need **python 3.10** or above.
Download the project source or clone this repo, in the project directory run:
```bash
> pip install -r requirements.txt
> python -m biscuit
```
If you use **poetry**, this will get biscuit up and running
```bash
> poetry install
> python -m biscuit
```
To run in a separate virtual environment, you can use [python poetry](https://python-poetry.org/).
To compile Biscuit for your platform, see [compiling guide](https://github.com/billyeatcookies/Biscuit/tree/main/scripts).

> **Note**
> If you are getting an error during installation in **Linux**, install following dependencies and try again:
Expand All @@ -37,18 +43,21 @@ If you use **poetry**, this will get biscuit up and running
> > pip install scikit-build
> ```
## Contributors
To contribute to the biscuit project, check our [contributing guidelines](./CONTRIBUTING.md). Your contributions and support are greatly appreciated! 🧡
## ❤ Contributors
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!
<a href="https://github.com/billyeatcookies/biscuit/graphs/contributors">
<img src="https://opencollective.com/biscuit/contributors.svg?width=890" />
</a>
## Screenshots ✨
![python_s8THu31T0Q](https://github.com/billyeatcookies/Biscuit/assets/70792552/032fac52-3f2f-4b1e-8908-a7b7c42aee13)
![python_k6yohhbuck](https://github.com/billyeatcookies/Biscuit/assets/70792552/e34ae3ca-7767-4210-a446-41a517af0e76)
## 📸 Screenshots
![python_33z3mLyKaj](https://github.com/billyeatcookies/Biscuit/assets/70792552/acb36423-65f3-46a0-b4a0-9e381b5d1995)
![python_fOxALHL7iv](https://github.com/billyeatcookies/Biscuit/assets/70792552/db279b28-859a-4376-a60e-10890235c729)
![python_haGYWbGzcX](https://github.com/billyeatcookies/Biscuit/assets/70792552/9e75f2c2-6a24-43e4-a3a2-fcaa1728d18c)
![python_MolICK4FSV](https://github.com/billyeatcookies/Biscuit/assets/70792552/6875cb5c-627c-4bae-9fcc-2a15d2a4b2ce)
## Features
## Features
- **Palette** which works based on various prompts used
(`Ctrl` + `shift` + `p` for command palette)
Expand Down
5 changes: 4 additions & 1 deletion biscuit/core/utils/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,10 @@ def quit(self, *_):
self.base.destroy()

def toggle_maximize(self, *_):
self.base.wm_state('normal' if self.maximized else 'zoomed')
if self.base.sysinfo.os != "Linux":
self.base.wm_state('normal' if self.maximized else 'zoomed')
else:
self.base.wm_attributes('-zoomed', self.maximized)
self.maximized = not self.maximized

def minimize(self, *_):
Expand Down

0 comments on commit 8caa59a

Please sign in to comment.