Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GhostNaN authored Nov 12, 2020
1 parent 2f67e5b commit fad1a34
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ The Good:
- Proper config file "settings.cfg"

The Bad:
- Terminal ONLY, no GUI yet...
- Missing cool features
- No Windows support

Expand Down Expand Up @@ -55,5 +54,23 @@ mkdir ~/.config/recidia/
cp settings.cfg ~/.config/recidia/
```

## Usage
### Running
Terminal version:
```
recidia
```
GUI version:
```
recidia literally any arg
```

### Customizing
Use the [settings.cfg](/settings.cfg) file to set:
- default behavior
- boundaries min/max
- keybindings/controls for runtime changes


## License
This project is licensed under the GPLv3 License - see the [LICENSE](/LICENSE) file for details

0 comments on commit fad1a34

Please sign in to comment.