From cf746306e306b8c2e10663ceed806c00e299a9dc Mon Sep 17 00:00:00 2001 From: emkael Date: Tue, 9 May 2017 03:18:30 +0200 Subject: README completed with release information and repository files links --- README.en.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) (limited to 'README.en.md') 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. -- cgit v1.2.3