diff --git a/README.md b/README.md index 215c90a..e217ad2 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,9 @@ Fasttyper by default looks for config file in: `$HOME/.config/fasttyper/config.j - **left_margin_percentage** - integer, percentage of screen used for left (and right) margin, by default 10 - **lines_on_screen** - integer, number of lines to display on screen, by default 3 -Example config files: +Example config file with all default values in avalibe [here](https://github.com/ickyicky/fasttyper/blob/main/doc/example_config.json). + +Other example config files: ```json {"top_margin_percentage": 40, "left_margin_percentage": 25} diff --git a/doc/example_config.json b/doc/example_config.json index e47deb2..f886497 100644 --- a/doc/example_config.json +++ b/doc/example_config.json @@ -1,9 +1,11 @@ { - "user_input_valid_color": 3, - "user_input_invalid_color": 2, - "reference_text_color": 8, - "stats_template": "\n\nwpm: {stats.wpm}\ntime: {stats.total_seconds}s", - "stats_color": 5, - "summary_template": "WPM: {stats.wpm}\nCPM: {stats.cpm}\nRAW WPM: {stats.raw_wpm}\nRAW CPM: {stats.raw_cpm}\ntotal seconds: {stats.total_seconds}\ntotal minutes: {stats.total_minutes}\ncorrect words: {stats.correct_words}\ncorrect chars: {stats.correct_chars}\nincorrect words: {stats.incorrect_words}\nincorrect chars: {stats.incorrect_chars}\ntotal words: {stats.total_words}\ntotal chars: {stats.total_chars}\naccuracy: {stats.accuracy}%", - "summary_datafile": "~/.cache/fasttyper/datafile.csv" -} + "user_input_valid_color":3, + "user_input_invalid_color":2, + "reference_text_color":8, + "stats_template":"\n\nwpm: {stats.wpm:0.2f}\ntime: {stats.total_seconds:0.2f}s", + "stats_color":5, + "summary_template":"WPM: {stats.wpm:0.2f}\nCPM: {stats.cpm:0.2f}\nRAW WPM: {stats.raw_wpm:0.2f}\nRAW CPM: {stats.raw_cpm:0.2f}\ntotal seconds: {stats.total_seconds:0.2f}\ntotal minutes: {stats.total_minutes:0.2f}\ncorrect words: {stats.correct_words}\ncorrect chars: {stats.correct_chars}\nincorrect words: {stats.incorrect_words}\nincorrect chars: {stats.incorrect_chars}\ntotal words: {stats.total_words}\ntotal chars: {stats.total_chars}\naccuracy: {stats.accuracy:0.2f}%", + "summary_datafile":"~/.cache/fasttyper/datafile.csv", + "top_margin_percentage":30, + "left_margin_percentage":10 +}