From e2350c3711852ee36374268b63369670c75ef04e Mon Sep 17 00:00:00 2001 From: EKNr1 Date: Sat, 7 Dec 2024 20:15:28 +0100 Subject: [PATCH] Updated README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f9b2c8f..819132a 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,19 @@ So I just made one. | Feature | Description | State | |--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| | Editing of basic image formats | If u have a very simple black/white image format
where single bits control the color,
the editor can highlight the enabled bits. | Implemented | + +## Setup + +To be able to use this program,\ +you have to clone the repository, install the requirements and make the file called "main.py" executable.\ +You can do that using these commands: + +```bash +git clone git@teapot.informationsanarchistik.de:Wobbl/Bread_Editor.git +cd Bread_Editor +pip install -r requirements.txt +chmod +x main.py +``` + +Now you can execute the program using `./main.py`. +You can also create a desktop shortcut to the file. \ No newline at end of file