summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2016-11-05 12:58:46 +0100
committeremkael <emkael@tlen.pl>2016-11-05 12:58:46 +0100
commit43159073d32743b71a4d0c8d456ccdcec66c1249 (patch)
tree1fa9b6a12b88cb1df8578e7ee10128f7f24df481 /README.md
parent534db3914c010f2b879f7c27d9268d775bd84418 (diff)
* documentation for command line switches completed
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index a7f614a..ad8c255 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,26 @@ Narzędzie obsługuje niestandardowe zakresy numeracji rozdań w turnieju.
Mapowanie numeru rozdań z Par na numer rozdania w BWS (numer fizycznego
pudełka) odbywa się automatycznie (na podstawie danych z BWS).
+Opcjonalne argumenty linii poleceń
+----------------------------------
+
+```
+bidding_data.py [-h] [-V] [-q | -v] [-l POZIOM_LOGÓW] [-f PLIK_LOGÓW]
+ [-s [ADRES_GOŃCA]]
+ DANE_SESJI.bws PLIK_TURNIEJU.html
+```
+
+Opis argumentów:
+ * `-h`, `--help`: wyświetla opis argumentów
+ * `-V`, `--version`: wyświetla numer wersji programu
+ * `-q`, `--quiet`: ucisza ostrzeżenia na standardowym wyjściu błędu
+ * `-v`, `--verbose`: wypisuje szczegółowe komunikaty na wyjściu błędu
+ * `-l LOGÓW`, `--log-level POZIOM`: ustawia szczegółowość logowania
+(`DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`)
+ * `-f PLIK`, `--log-file PLIK`: ścieżka pliku logów
+ * `-s [GONIEC]`, `--send-files [GONIEC]`: włącza transmisję Gońcem
+(domyślny adres: `localhost:8090`)
+
Użycie (wersja z interfejsem okienkowym)
----------------------------------------
@@ -85,7 +105,8 @@ Wersja operująca na wyeksportowanych plikach CSV (np. przez `mdb-export`),
kompatybilna z pozostałymi systemami operacyjnymi i niewymagająca ODBC,
dostępna jest w gałęzi [csv](//github.com/emkael/jfrpary-bidding-data/tree/csv).
-Do wersji z gałęzi CSV nie ma interfejsu graficznego.
+Do wersji z gałęzi CSV nie ma interfejsu graficznego. Wersja z gałęzi CSV
+została porzucona w wersji ok. 1.0, z czystego lenistwa.
Lista przyszłych usprawnień
---------------------------