diff options
| -rw-r--r-- | README.en.md | 30 | ||||
| -rw-r--r-- | README.pl.md | 30 |
2 files changed, 40 insertions, 20 deletions
diff --git a/README.en.md b/README.en.md index 8c5da0c..86f61d1 100644 --- a/README.en.md +++ b/README.en.md @@ -6,7 +6,7 @@ Tools that allows calculation and presentation of a normalized butler (a so-call Installation ------------ -1. Download the program package from author's website. +1. Download the program package from [author's website](https://github.com/emkael/jfrteamy-ausbutler/releases). 2. Unpack it to the desired directory. 3. Configure appropriate database connection. 4. Run `butler.exe` in application directory. @@ -29,7 +29,9 @@ Configuration files The application relies on five configuration files, JSON-formatted, placed in the `config` subdirectory. -`db.json` +~~~ + +[`db.json`](config/db.json.EXAMPLE) Defines event database connection parameters: @@ -38,7 +40,9 @@ Defines event database connection parameters: * `db` - event database name * `host` - DB server location -`butler.json` +~~~ + +[`butler.json`](config/butler.json) Defines butler calculation parameters. @@ -55,14 +59,18 @@ All calculations are independent from the way raw butler is calculated for all t Finally, the `segments_in_table_limit` parameters defines how many latest segments are presented in detail in the summary table for the normalized butler (`PREFIXnormbutler.html`). All the previous segments are included in the table header, in compliance with JFR Teamy convention. -`goniec.json` +~~~ + +[`goniec.json`](config/goniec.json) Defines standard parameters for Goniec transmission. * `enabled` turns the transmission on * `host` and `port` point to the Goniec location -`logoh.json` +~~~ + +[`logoh.json`](config/logoh.json) Sets the mapping for text strings used by the application within generated pages to the event database translation identifiers. Typically, doesn't need any adjustments. @@ -70,7 +78,9 @@ Every string should be present in the `logoh` table of the event database. **BEWARE**: in case the program raises `KeyError: NUMERIC_ID` error in lines responsible for translating strings, you should reload the correct `.language` into the JFR Teamy event database. -`translation.json` +~~~ + +[`translation.json`](config/translation.json) Sets translations for the strings that are generated by the program, but are not present in the JFR Teamy event database. @@ -83,10 +93,10 @@ Page templates The `template` directory contains fully customizable page templates for the files generated by the program. - * `table.html` is the template for the normalized butler summary table - `PREFIXnormbutler.html` file - * `frame.html` is the frame template for the normalized butler resutls of single segments - `PREFIXbutlerSEGMENT.htm` files - * `segment.html` is the template for the normalized butler pairs resutls of single segments - `PREFIXbutlerSEGMENT.html` files - * `macros.html` contains various partial templates used in multiple places of other templates - stuff like headers, separators, result table rows or page footer + * [`table.html`](template/table.html) is the template for the normalized butler summary table - `PREFIXnormbutler.html` file + * [`frame.html`](template/frame.html) is the frame template for the normalized butler resutls of single segments - `PREFIXbutlerSEGMENT.htm` files + * [`segment.html`](template/segment.html) is the template for the normalized butler pairs resutls of single segments - `PREFIXbutlerSEGMENT.html` files + * [`macros.html`](template/macros.html) contains various partial templates used in multiple places of other templates - stuff like headers, separators, result table rows or page footer In most cases there's no need to modify these templates - they're compatible with the standard JFR Teamy formatting. diff --git a/README.pl.md b/README.pl.md index 2fa6c8f..6fa927d 100644 --- a/README.pl.md +++ b/README.pl.md @@ -6,7 +6,7 @@ Narzędzie umożliwiające obliczanie i prezentację znormalizowanego butlera (t Instalacja ---------- -1. Ściągnąć paczkę z programem ze strony autora. +1. Ściągnąć paczkę z programem ze [strony autora](https://github.com/emkael/jfrteamy-ausbutler/releases). 2. Rozpakować paczkę do pożądanego katalogu. 3. Skonfigurować odpowiednie połączenie z bazą danych. 4. Wywołać w katalogu programu plik `butler.exe`. @@ -29,7 +29,9 @@ Pliki konfiguracyjne Aplikacja korzysta z pięciu plików konfiguracyjnych, formatu JSON, umiejscowionych w podkatalogu `config` katalogu programu. -`db.json` +~~~ + +[`db.json`](config/db.json.EXAMPLE) Określa parametry połączenia z bazą danych turnieju: @@ -38,7 +40,9 @@ Określa parametry połączenia z bazą danych turnieju: * `db` - nazwę bazy turnieju * `host` - serwer bazy danych -`butler.json` +~~~ + +[`butler.json`](config/butler.json) Definiuje parametry obliczania butlera znormalizowanego. @@ -55,14 +59,18 @@ Wszystkie obliczenia nie zależą od sposobu wyliczania nieznormalizowanego butl W końcu, parametr `segments_in_table_limit` określa, ile segmentów najnowszych widocznych jest szczegółowo w zbiorczej tabeli znormalizowanego butlera (`PREFIXnormbutler.html`). Wszystkie wcześniejsze segmenty dołączone są w nagłówku tabeli, zgodnie z konwencją JFR Teamy. -`goniec.json` +~~~ + +[`goniec.json`](config/goniec.json) Określa standardowe parametry przesyłania plików Gońcem. * `enabled` włącza wysyłanie Gońcem * `host` i `port` wskazują lokalizację Gońca -`logoh.json` +~~~ + +[`logoh.json`](config/logoh.json) Ustawia mapowanie łańcuchów tekstowych używanych przez aplikację w generowanych stronach na identyfikatory do pobrania tekstów z bazy danych turnieju. Przeważnie nie wymaga ingerencji. @@ -70,7 +78,9 @@ Każdy tekst powinien znajdować się w tabeli `logoh` bazy danych turnieju. **UWAGA**: w przypadku wystąpienia w programie błędu `KeyError: ID_TŁUMACZENIA` w liniach wskazujących na pobieranie tłumaczeń, należy do bazy danych turnieju w JFR Teamy wczytać ponownie poprawny plik `.language`. -`translation.json` +~~~ + +[`translation.json`](config/translation.json) Ustawia teksty tłumaczeń, używane w stronach generowanych przez program, a niezawarte domyślnie w bazach turniejów JFR Teamy. @@ -83,10 +93,10 @@ Szablony stron Katalog `template` zawiera w pełni modyfikowalne szablony stron generowanych przez program. - * `table.html` to szablon tabeli zbiorczej znormalizowanego butlera - pliku `PREFIXnormbutler.html` - * `frame.html` to szablon ramki wyświetlającej wyniki znormalizowanego butlera pojedynczego segmentu - plików `PREFIXbutlerSEGMENT.htm` - * `segment.html` to szablon tabeli wyników znormalizowanego butlera dla poszczególnych par w pojedynczym segmencie - plików `PREFIXbutlerSEGMENT.html` - * `macros.html` zawiera szablony wstawek używanych w różnych miejscach innych szablonów - nagłówków, separatorów, wierszy tabeli wyników czy stopki stron + * [`table.html`](template/table.html) to szablon tabeli zbiorczej znormalizowanego butlera - pliku `PREFIXnormbutler.html` + * [`frame.html`](template/frame.html) to szablon ramki wyświetlającej wyniki znormalizowanego butlera pojedynczego segmentu - plików `PREFIXbutlerSEGMENT.htm` + * [`segment.html`](template/segment.html) to szablon tabeli wyników znormalizowanego butlera dla poszczególnych par w pojedynczym segmencie - plików `PREFIXbutlerSEGMENT.html` + * [`macros.html`](template/macros.html) zawiera szablony wstawek używanych w różnych miejscach innych szablonów - nagłówków, separatorów, wierszy tabeli wyników czy stopki stron W większości przypadków użycia nie ma potrzeby modyfikowania tych szablonów - są one zgodne z formatowaniem JFR Teamy. |