From 38c804194f71e9aa27a783d8f8d0ee0557c6614e Mon Sep 17 00:00:00 2001 From: volyc Date: Wed, 14 Feb 2024 14:40:31 -0500 Subject: [PATCH] Updated README file --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 725718a..795d574 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,11 @@ TODO - add to crates.io ## Usage +After installing the package, run `mlbt` from you terminal +to open the program. + +Press `q` to exit the program at any time. + There are four main tabs: - Scoreboard @@ -183,15 +188,6 @@ displayed red. ## Config -You can configure the TUI with the toml file located at your users' home -directory. For a user named `Alice` this would be: - -- Linux: /home/alice/.config/mlbt/mlbt.toml -- Windows: C:\Users\Alice\AppData\Roaming\mlbt\mlbt.toml -- macOS: /Users/Alice/Library/Application Support/mlbt/mlbt.toml - -> you can see the path for your user in the `Help` page. - ### Available settings - `favorite_team`: This will make that team always show up first in the schedule