diff options
| author | emkael <emkael@tlen.pl> | 2013-09-15 22:13:32 +0200 |
|---|---|---|
| committer | emkael <emkael@tlen.pl> | 2013-09-15 22:13:32 +0200 |
| commit | 7412f15914e1a270ca859f0656fc834ac9b66bfd (patch) | |
| tree | 0b5d471ad6bdacd98d097d4e840ffde8048cac52 /README.md | |
| parent | 01c3ef8f7a1b5a0ef9c0547febfc75de22d6b8ab (diff) | |
* formatowanie README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -7,11 +7,13 @@ Wymagania systemowe ------------------- Wersja konsolowa: + * interpreter PHP 5.3+[1] z modułem JSON [1]: z wyjątkiem testów jednostkowych z katalogu [/tests/](tests) - kompletnie niepotrzebnych użytkownikowi końcowemu - te wymagają PHP 5.4+ Wersja interaktywna (WWW), dodatkowo: + * eee... serwer WWW? * biblioteki JavaScript: + [jQuery](http://jquery.com) @@ -22,9 +24,11 @@ Instalacja ---------- Wersja konsolowa: + Wystarczające jest ściągnięcie paczki z głównego katalogu repozytorium albo ręczne ściągnięcie całości katalogu [/bin/](bin/) z repozytorium. Wersja interaktywna: + Po ściągnięciu z repozytorium katalogów [/web/](web/) oraz [/bin/](bin/), należy: * umieścić zawartość katalogu [/web/](web/) w miejscu dostępnym dla serwera WWW * w podkatalogu /web/lib/ umieścić wymagane biblioteki JavaScript (niedostarczane z aplikacją) @@ -35,16 +39,19 @@ Użycie ------ Wersja konsolowa: + W katalogu instalacji wydać polecenie: ``` php osika [OPCJE] REKA ``` + Dodatkowo, w systemach uniksowych, po nadaniu praw do wykonywania dla pliku [/bin/osika](bin/osika/), możliwe jest bezpośrednie wywołanie: ``` ./osika [OPCJE] REKA ``` REKA + Dane wejściowe - zawartość ręki. Wszystkie 13 kart w formacie przecinkowym, tj. xxx,xxx,xxxx,xxx. Dodatkowo: * ignorowane są białe znaki. * wielkość liter nie ma znaczenia @@ -56,12 +63,17 @@ Dane wejściowe - zawartość ręki. Wszystkie 13 kart w formacie przecinkowym, * blotki nie są weryfikowane (kolor może posiadać zduplikowane blotki, może też posiadać niemożliwą liczbę blotek, np. 10) OPCJE + -h, --help: wyświetlają instrukcję obsługi + -f FORMAT, --format FORMAT: format wyników programu; dostępne wartości: raw, table, json; wartość domyślna: table + -s KOLORY, --suits KOLORY: lista kolorów, dla których podawane są wyniki (rozdzielona przecinkami); dostępne wartości: s, h, d, c, total, all; wartość domyślna: all + -c KATEGORIE, --categories KATEGORIE: lista składników analizy siły ręki (rozdzielona przecinkami); dostępne wartości wymienione są w pomocy programu (`php osika -h`); wartość domyślna: all Wersja interaktywna: + Się wpisuje, się klika i się wyświetla. Podziękowania i autorstwo @@ -79,6 +91,7 @@ Licencja -------- Program udostępniany jest na licencji GPL wersji 2. + Szczegóły licencji znajdują się w pliku [LICENSE](LICENSE) *** |