docs: update README.md

This commit is contained in:
Stevan Freeborn
2026-07-22 23:16:54 -05:00
parent b12059ce3d
commit a5443f5df7
+46 -41
View File
@@ -24,45 +24,7 @@ When termato is running, control the application using the following keys:
> [!NOTE] > [!NOTE]
> The in-app help overlay (`?`) requires a minimum terminal window size to be displayed. > The in-app help overlay (`?`) requires a minimum terminal window size to be displayed.
## Getting Started ## Installation
### Prerequisites
Ensure you have Rust and Cargo installed. If not, download them via [rustup.rs](https://rustup.rs/).
### Running with Defaults
To run termato with the default settings (25-minute focus session, 5-minute break):
```bash
cargo run --release
```
### Specifying Custom Session Times
You can specify custom session durations as command-line arguments in minutes:
```bash
cargo run --release -- [work_minutes] [break_minutes]
```
For example, to run a 50-minute focus session followed by a 10-minute break:
```bash
cargo run --release -- 50 10
```
### Help and Version
To print the help message or version directly without entering the TUI:
```bash
cargo run --release -- -h
cargo run --release -- --help
cargo run --release -- --version
```
## Building and Installation
To install `termato` using the automated installers: To install `termato` using the automated installers:
@@ -78,12 +40,55 @@ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/StevanFreeborn/termato/
irm https://github.com/StevanFreeborn/termato/releases/latest/download/termato-installer.ps1 | iex irm https://github.com/StevanFreeborn/termato/releases/latest/download/termato-installer.ps1 | iex
``` ```
To install `termato` globally from source using Cargo: ## Getting Started
### Running with Defaults
To run termato with the default settings (25-minute focus session, 5-minute break):
```bash
termato
```
### Specifying Options and Custom Session Times
By default, desktop notifications are disabled. You can specify options and custom session durations as command-line arguments:
```bash
termato [options] [work_minutes] [break_minutes]
```
For example, to enable desktop notifications and run a 50-minute focus session followed by a 10-minute break:
```bash
termato -n 50 10
```
Or using the long flag:
```bash
termato --notify 50 10
```
### Help and Version
To print the help message or version directly without entering the TUI:
```bash
termato -h
termato --help
termato --version
```
## Building and Installing from Source
To install `termato` globally from source (requires Rust and Cargo):
```bash ```bash
cargo install --path . cargo install --path .
``` ```
Alternatively, to build a standalone optimized binary manually: Alternatively, to build a standalone optimized binary manually from source (requires Rust and Cargo):
```bash ```bash
cargo build --release cargo build --release