From fc24e659a4c7e4c152878867a8d67d4413a8cfa1 Mon Sep 17 00:00:00 2001 From: Dima yawaflua Andreev Date: Wed, 30 Oct 2024 08:35:45 +0200 Subject: [PATCH] Create README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..abdb294 --- /dev/null +++ b/README.md @@ -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 |