Bread_Editor/README.md

# Bread Editor

I couldn't find any binary editor with that you can edit single bits,\
but I needed to write some binary data in a digital logic simulator.\
So I just made one.

### Features

| Feature                                                   | Description                                                                                                                                | State                                                  |
|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| Editing of basic image formats /<br>"Syntax Highlighting" | If you have a very simple black/white image format<br/>where single bits control the color,<br/>the editor can highlight the enabled bits. | <input type="checkbox" disabled checked /> Implemented |

## Setup

This program was made for Linux. It may work on Windows or Mac too, but it was not tested on these systems.\
Before you can install the editor, you first have to install the requirements. That can be done using:

```bash
sudo apt install pyqt6-dev-tools xcb libxcb-cursor0
```

And to install the editor, you just have to clone the repository and install it using pip.\
You can do that using these commands:

```bash
git clone https://teapot.informationsanarchistik.de/Wobbl/Bread_Editor.git
cd Bread_Editor
pip install .
```

If you have already set up git for ssh, you can also clone the repository like this:

```bash
git clone git git@teapot.informationsanarchistik.de:Wobbl/Bread_Editor.git
```

You can now start the editor by typing in the terminal: `bread_editor`