Wobbl/Bread_Editor
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Modified the README.md accordingly to the latest changes.

Browse source 
(Explained how to install the editor using pip)
This commit is contained in:
The Wobbler 2024-12-14 18:50:49 +01:00
parent b7a6ba567a
commit ea8b7456cc
1 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -6,25 +6,23 @@ So I just made one.
### Features ### Features
| Feature | Description | State | | Feature | Description | State |
|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| |-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| Editing of basic image formats /<br>"Syntax Highlighting" | If u 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 | | 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 ## Setup
This program was made for Linux.\ This program was made for Linux.\
It may work on Windows or Mac too, but it was not tested on these systems.\ 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,\ To install the editor, you just have to clone the repository,\
install the requirements, convert the ui files to python files\ convert the ui files to python files and install the editor using pip.\
and make the file called "main.py" executable.\
You can do that using these commands: You can do that using these commands:
```bash ```bash
git clone https://teapot.informationsanarchistik.de/Wobbl/Bread_Editor.git git clone https://teapot.informationsanarchistik.de/Wobbl/Bread_Editor.git
cd Bread_Editor cd Bread_Editor
pip install -r requirements.txt
python3 gui/raw_ui/ui_to_py.py 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: 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 git clone git git@teapot.informationsanarchistik.de:Wobbl/Bread_Editor.git
``` ```
Now you can execute the program using `./main.py`. You can now start the editor by typing in the terminal: `bread_editor`
You can also create a desktop shortcut to the file.