From ea8b7456cc4825bb630aba7b906d5f3058f11565 Mon Sep 17 00:00:00 2001 From: EKNr1 Date: Sat, 14 Dec 2024 18:50:49 +0100 Subject: [PATCH] Modified the README.md accordingly to the latest changes. (Explained how to install the editor using pip) --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4df07cb..b6f4ca2 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,23 @@ So I just made one. ### Features -| Feature | Description | State | -|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| -| Editing of basic image formats /
"Syntax Highlighting" | If u have a very simple black/white image format
where single bits control the color,
the editor can highlight the enabled bits. | Implemented | +| Feature | Description | State | +|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| +| Editing of basic image formats /
"Syntax Highlighting" | If you have a very simple black/white image format
where single bits control the color,
the editor can highlight the enabled bits. | Implemented | ## Setup This program was made for Linux.\ It may work on Windows or Mac too, but it was not tested on these systems.\ -To be able to use this program, you have to clone the repository,\ -install the requirements, convert the ui files to python files\ -and make the file called "main.py" executable.\ +To install the editor, you just have to clone the repository,\ +convert the ui files to python files and install the editor 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 -r requirements.txt python3 gui/raw_ui/ui_to_py.py -chmod +x main.py +pip install . ``` If you have already set up git for ssh, you can also clone the repository like this: @@ -33,5 +31,4 @@ If you have already set up git for ssh, you can also clone the repository like t git clone git git@teapot.informationsanarchistik.de:Wobbl/Bread_Editor.git ``` -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 +You can now start the editor by typing in the terminal: `bread_editor` \ No newline at end of file