improved README

This commit is contained in:
Albert S. 2019-08-24 09:48:30 +02:00
parent 1284519280
commit 028b4299f7

View File

@ -18,31 +18,31 @@ For the calculation engine, libqalculate is needed.
Currently no conditional compile flags are supported... Currently no conditional compile flags are supported...
Building Building
======== --------
Assuming the necessary dependencies are installed:
```
qmake qmake
make make
```
Getting started Getting started
---------------- ----------------
Currently it may not be considered a classical GUI application because the $HOME/.config/qsrun
configuration must be done outside of it.
mkdir $HOME/.config/qsrun
In this folder user-defined entries should be put (See "Entry format"). In this folder user-defined entries should be put (See "Entry format").
Config format Config format
------------ ------------
Path: $HOME/.config/qsrun/qsrunner.config Path: $HOME/.config/qsrun/qsrun.config
Example:
``` ```
[General] [General]
sysAppsPaths="/usr/share/applications/" TODO: multiple dir example sysAppsPaths = "/usr/share/applications/", "/var/lib/snapd/desktop/applications/"
``` ```
systemApplicationsPath will default to "/usr/share/applications/", sysAppsPaths will default to "/usr/share/applications/" if no value
therefore specifying it explicitly is not necessary. is given.
Entry format Entry format
------------ ------------