Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README file #40

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated README file #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Comment on lines -186 to -194
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to keep this since there should be a config file

### Available settings

- `favorite_team`: This will make that team always show up first in the schedule
Expand Down
Loading