summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2015-10-26 16:14:57 +0100
committeremkael <emkael@tlen.pl>2015-10-26 16:14:57 +0100
commit67b7163a5d0bb4ef4d10dbc59ca1a7e10aee0782 (patch)
tree92af101d8ab744e22b2ad0d2df9066c17ec998ce /README.md
parent2884d5270fa258ac2f9bd988cba2a75dd2eeed04 (diff)
* GUI version docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index aab5bb2..a7f614a 100644
--- a/README.md
+++ b/README.md
@@ -24,12 +24,15 @@ Instalacja
repozytorium i rozpakuj ją do wybranego przez siebie katalogu roboczego
programu.
+Uwaga: paczki z sufiksem `-gui` zawierają wersję aplikacji z okienkowym
+interfejsem graficznym.
+
W katalogu WWW Par skonfiguruj zasoby niezbędnę do prezentacji danych
licytacji:
* skopiuj [`css/bidding.css`](res/css/bidding.css) do katalogu WWW
* dołącz plik [`css/bidding.css`](res/css/bidding.css) gdzieś w arkuszach
stylów turnieju (np. poprzez `@import` w `kolorki.css`)
-* skopiuj [`javas/bidding.js`](res/javas/bidding.js) do podkatalogu javas
+* skopiuj [`javas/bidding.js`](res/javas/bidding.js) do podkatalogu javas
katalogu WWW (plik dołączany jest automatycznie do stron z wynikami)
* skopiuj [`images/link.png`](res/images/link.png) do podkatalogu images
katalogu WWW
@@ -41,12 +44,12 @@ Kompilacja i praca z kodem narzędzia
Patrz: [`BUILD.md`](BUILD.md)
-Użycie
-------
+Użycie (wersja linii poleceń)
+-----------------------------
Program składa się ze skompilowanego skryptu języka Python, dostępnego
w katalogu [`src`](src) tego repozytorium.
-
+
Skrypt [`bidding_data.py`](src/bidding_data.py) operuje na następujących
danych wejściowych:
* plikach HTML wygenerowanych po zakończeniu turnieju stron statycznych
@@ -67,6 +70,11 @@ 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).
+Użycie (wersja z interfejsem okienkowym)
+----------------------------------------
+
+Się klika, się wybiera i się robi.
+
Kompatybilność
--------------
@@ -77,6 +85,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.
+
Lista przyszłych usprawnień
---------------------------