Create README.md

This commit is contained in:
Dima yawaflua Andreev
2024-10-30 08:35:45 +02:00
committed by GitHub
parent 27632fa5c6
commit fc24e659a4

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# Linux app for tzeva-adom and OREF.
This application can show a notification with sound to the PC user when tzeva-adom and oref are running.
# Working
## Starting:
For start this app, you should to make this actions:
- Build the app:
- ```bash
cmake .
make
```
- Start the app:
- ```bash
cd cmake-build-debug
./tzeva-adom --help --lang en
```
## Command args:
| flag | description | value |
|---------|----------------------------------------------------------------|------------|
| --lang | Changes the language of alerts | `en/he/ru` |
| -l | Alias of `--lang` | `en/he/ru` |
| --test | Creates a test alert on start, after it working in normal mode | none |
| -t | Alias of `--test` | none |
| --debug | Show debug data about alerts | none |
| -d | Alias of `--debug` | none |