From 15cb9a3da343ca0b6c9c5660d8dc09a2ccd847ab Mon Sep 17 00:00:00 2001 From: emkael Date: Thu, 23 Feb 2017 00:32:53 +0100 Subject: Renaming documentation --- README | 73 ------------------------------------------------------------------ 1 file changed, 73 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 272a976..0000000 --- a/README +++ /dev/null @@ -1,73 +0,0 @@ -JFR Teamy - play-off -==================== - -Generator drabinek wizualizacji play-off dla turniejów prowadzonych przy użyciu JFR Teamy. - -Przykład wizualizacji: [III liga LD, sezon 2016/17](https://emkael.info/brydz/playoff/). - -Wymagania systemowe -------------------- - -Dla wersji skompilowanej: jakiś współczesny system rodziny MS Windows. - -Dla wersji skryptowej: - * Python 2.x ze standardowym zestawem bibliotek - * MySQL connector dla Pythona - -Instalacja ----------- - -Dla wersji skompilowanej: ściągnąć, rozpakować, upewnić się, że [`playoff.js`](playoff.js) jest w katalogu pliku wykonywalnego. - -Dla wersji skryptowej: sklonować to repozytorium. - -Użycie ------- - -Niezależnie od wersji, należy wykonać w linii poleceń polecenie: - -``` -playoff.exe PLIK_USTAWIEŃ_JSON -``` - -lub - -``` -python playoff.py PLIK_USTAWIEŃ_JSON -``` - -`PLIK_USTAWIEŃ_JSON` jest plikiem konfiguracyjnym, dostarczającym wszelkich danych niezbędnych do pracy programu. - -Jego strukturę opisuje dokument [CONFIG](CONFIG). - -Znane ograniczenia ------------------- - - * wszystkie mecze danej fazy muszą lądować na FTP w tej samej ścieżce: -linki generowane są na podstawie URL całej fazy (linki z datami u góry), -prefiksów turniejów oraz numerów rund - * brak obsługi "ręczników" - trzeba wypełnić zręcznikowany segment -średnimi, żeby pokazało, że mecz się skończył - * fazy powinny być określone raczej chronologicznie (czytaj: nie -testowano, co się stanie, jeśli określimy np., że w meczu fazy 2 ma zagrać -zwycięzca z fazy 4), ale nie powinno być problemu z "przeskakiwaniem" -faz (czyli awansem zwycięzcy z fazy 1 od razu do fazy 3), przy czym -takiej sytuacji też nie testowano (rysować się powinno, ale ubytki estetyczne są prawie pewne) - * program wymaga działania Webmastera (wyniki czytane są z takiego -miejsca bazy, do którego pisze Webmaster, a z jakichś powodów nie pisze -Admin przy zamykaniu rundy/segmentu), więc nawet w przypadku grania -"off-line" (Kolektor+statyczne po każdym segmencie), może być potrzeba -przejechania segmentu Webmasterem - * przez cały czas trwania play-off pełne nazwy teamów (w bazach i te -określone w JSONie) muszą się zgadzać - teamy są rozróżniane po nich właśnie - * skorzystanie z funkcjonalności umieszczenia drużyny na określonym miejscu klasyfikacji końcowej (przed rozegraniem play-off) wymaga obecności flag teamów - -Autor ------ - -Michał Klichowicz (mkl) - -Licencja --------- - -[Uproszczona licencja BSD](LICENSE) -- cgit v1.2.3