Skip to content

Commit

Permalink
update README with custom configuration (#38)
Browse files Browse the repository at this point in the history
Add doc about custom configuration
  • Loading branch information
0xHumban authored Dec 3, 2024
1 parent a32e6bf commit 6814e35
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,25 @@ This will produce an executable file at `target/release/tenere` that you can cop

## ⚙️ Configuration

Tenere can be configured using a TOML configuration file. The file should be located in :
Tenere can be configured using a TOML configuration file. By default, the configuration file is located at:

- Linux : `$HOME/.config/tenere/config.toml` or `$XDG_CONFIG_HOME/tenere/config.toml`
- Mac : `$HOME/Library/Application Support/tenere/config.toml`
- Windows: `~/AppData/Roaming/tenere/config.toml`
- **Linux**: `$HOME/.config/tenere/config.toml` or `$XDG_CONFIG_HOME/tenere/config.toml`
- **Mac**: `$HOME/Library/Application Support/tenere/config.toml`
- **Windows**: `~/AppData/Roaming/tenere/config.toml`

### 🛠 Custom Configuration Path

You can optionally specify a custom path for the configuration file using the `-c` flag. This allows you to override the default configuration file location.

### Example Usage

```sh
# Use the default configuration path
tenere

# Specify a custom configuration path
tenere -c ~/path/to/custom/config.toml
```

### General settings

Expand Down

0 comments on commit 6814e35

Please sign in to comment.