improving README

This commit is contained in:
Vinicius Moreira
2019-09-17 17:43:09 -03:00
parent 18238eb269
commit 437335610b

View File

@@ -30,20 +30,17 @@ It has a **tray mode** (see **Settings** below) that attaches the application ic
### Distribution ### Distribution
**PyPi**
```
pip3 install bauh (may require **sudo**)
```
**AUR** **AUR**
As **bauh** package. There is also a staging version (**bauh-staging**) but is intended for testing and may not work properly. As **bauh** package. There is also a staging version (**bauh-staging**) but is intended for testing and may not work properly.
**PyPi**
```pip3 install bauh ``` ( may require **sudo**, but prefere the *Manual installation** described below to not mess up with your system libraries )
### Manual installation: ### Manual installation:
If you prefer a manual and isolated installation: If you prefer a manual and isolated installation, type the following commands within the cloned project folder:
If you cloned this project, type the following commands within its folder:
``` ```
python3 -m venv env ( creates a virtualenv in a folder called **env** ) python3 -m venv env ( creates a virtualenv in a folder called **env** )
@@ -51,7 +48,7 @@ env/bin/pip install . ( install the application code inside the **env** )
env/bin/bauh ( launch the application ) env/bin/bauh ( launch the application )
``` ```
If you want do not want to clone / download this repository, go your Home folder and execute the commands above, but replace the second by ```env/bin/pip install bauh```. If you want do not want to clone / download this repository, go your **Home** folder and execute the commands above, but replace the second by ```env/bin/pip install bauh```.
### Autostart ### Autostart
@@ -72,15 +69,12 @@ You can change some application settings via environment variables or arguments
- **BAUH_SUGGESTIONS**: If application suggestions should be displayed if no app is installed (runtimes do not count as apps). Use **0** (disable) or **1** (enable, default). - **BAUH_SUGGESTIONS**: If application suggestions should be displayed if no app is installed (runtimes do not count as apps). Use **0** (disable) or **1** (enable, default).
- **BAUH_MAX_DISPLAYED**: Maximum number of displayed packages in the management panel table. Default: 200. - **BAUH_MAX_DISPLAYED**: Maximum number of displayed packages in the management panel table. Default: 200.
### How to improve the application performance ### How to improve **bauh** performance
- If you don't care about a specific packaging technology and don't want the app to deal with it, just disable it via the specific argument or environment variable. For instance, if I don't care - If you don't care about a specific packaging technology and don't want **bauh** to deal with it, just disable it via the graphical interface.
about **snaps**, I can initialize the application setting "snap=0" (**bauh --snap=0**). This will improve the application response time, since it won't need to do any verifications associated - If you don't care about restarting the app every time a new supported packaging technology is installed, set "check-packaging-once=1" (**bauh --check-packaging-once=1**). This can reduce the application response time up in some scenarios, since it won't need to recheck if the packaging type is available for every action you request.
with the technology that I don't care every time an action is executed.
- If you don't care about restarting the app every time a new supported packaging technology is installed, set "check-packaging-once=1" (**bauh --check-packaging-once=1**). This can reduce the application response time up to 80% in some scenarios, since it won't need to recheck if the packaging type is available for every action you request.
- If you don't mind to see the applications icons, you can set "download-icons=0" (**bauh --download-icons=0**). The application may have a slight response improvement, since it will reduce the parallelism within it. - If you don't mind to see the applications icons, you can set "download-icons=0" (**bauh --download-icons=0**). The application may have a slight response improvement, since it will reduce the parallelism within it.
- If you don't mind app suggestions, disable it (**bauh --sugs=0**) - If you don't mind app suggestions, disable it (**bauh --sugs=0**)
### Code structure ### Code structure
#### Modules #### Modules
**view**: code associated with the graphical interface **view**: code associated with the graphical interface
@@ -89,9 +83,8 @@ with the technology that I don't care every time an action is executed.
the **view** code is only attached to them (it does not know how the **gems** handle the actions) the **view** code is only attached to them (it does not know how the **gems** handle the actions)
**commons**: common code used by **gem** and **view** **commons**: common code used by **gem** and **view**
### Roadmap ### Roadmap
- Support for other packaging technologies - Support for other packaging technologies
- Separate modules for each packaging technology - Separate modules for each packaging technology
- Memory and performance improvements - Memory and performance improvements
- Improve user experience - Improve user experience