summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2591a6d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+Kalkulator PKL
+==============
+
+Kalkulator punktów klasyfikacyjnych Polskiego Związku Brydża Sportowego.
+
+Dostępny na [http://pzbs.pl/sedziowie/pkl/](stronie PZBS).
+
+Zawartość repozytorium
+----------------------
+
+Katalog [`http`](http) to zawartość udostępniana na stronie PZBS:
+ * [`pkle2018.php`](http/pkle2018.php) to aktualny kalkulator
+ * [`pkle2014.php`](http/pkle2014.php) i [`pkle2009.php`](http/pkle2009.php) to archiwalne wersje dla poprzednich Regulaminów Klasyfikacyjnych
+ * [`index.php`](http/index.php) i ['pkle.php'](http/pkle.php) przekierowują do aktualnej wersji kalkulatora
+ * [`api.php`](http/api.php) to eksperymentalna wersja kalkulatora - w postaci interfejsu programistycznego, używana również przez testową wersję aktualnego kalkulatora ([`pkle2018-test.php`](http/pkle2018-test.php)) - opisana w [osobnym dokumencie](API.md)
+
+Katalog [`test`](test) to zestaw testów porównujących wyniki otrzymywane w "starym" kalkulatorze ([`pkle2018.php`](http/pkle2018.php)) z wyjściem kalkulatora w wersji API.
+
+Autorzy
+-------
+
+Oryginalna wersja: Jan Romański
+
+Późniejsze poprawki: Michał Zimniewicz, Marcin Wasłowicz, Michał Klichowicz
+
+Licencja
+--------
+
+?