Update README
This commit is contained in:
parent
b9fbcd70fd
commit
5b31e8f60f
1 changed files with 9 additions and 4 deletions
13
README.md
13
README.md
|
@ -4,15 +4,19 @@ tori is a tool to track your personal systems' configurations and replicate them
|
||||||
|
|
||||||
If you'd like a more detailed description of what it is, its purpose, origins and goals, see the [announcement blog post](https://blog.jutty.dev/posts/introducing-tori.html).
|
If you'd like a more detailed description of what it is, its purpose, origins and goals, see the [announcement blog post](https://blog.jutty.dev/posts/introducing-tori.html).
|
||||||
|
|
||||||
You can find documentation in the [docs](docs) directory:
|
Refer to the [project website](https://tori.jutty.dev) for updates and access to [documentation](https://tori.jutty.dev/docs).
|
||||||
- [Usage documentation](docs/usage)
|
|
||||||
- [Development documentation](docs/development)
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
As it is still in very early development, tori is not yet packaged.
|
As it is still in very early development, tori is not yet packaged.
|
||||||
|
|
||||||
If you want to try it, you can clone this repository to your system and create the configuration file at `~/.config/tori/tori.conf` containing the following setting:
|
If you want to try it, you can clone its repository to your system:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://brew.bsd.cafe/jutty/tori.git /path/to/repository
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, create `~/.config/tori/tori.conf` with the following content:
|
||||||
|
|
||||||
```conf
|
```conf
|
||||||
tori_root = /path/to/repository
|
tori_root = /path/to/repository
|
||||||
|
@ -31,6 +35,7 @@ ln -s /path/to/repository/tori $HOME/.local/bin/tori
|
||||||
Currently, the following commands are implemented:
|
Currently, the following commands are implemented:
|
||||||
|
|
||||||
- `check`: check for divergences between the configuration and the system
|
- `check`: check for divergences between the configuration and the system
|
||||||
|
- `cache`: force an update of the local package cache
|
||||||
- `help`: show a usage summary with supported options
|
- `help`: show a usage summary with supported options
|
||||||
- `version`: print the current version and its release date
|
- `version`: print the current version and its release date
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue