From 5b31e8f60f81b2d25ee8f9f9a0ea24bead246017 Mon Sep 17 00:00:00 2001 From: jutty Date: Fri, 12 Jul 2024 08:17:34 -0300 Subject: [PATCH] Update README --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6cb104d..c25a9a3 100644 --- a/README.md +++ b/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). -You can find documentation in the [docs](docs) directory: -- [Usage documentation](docs/usage) -- [Development documentation](docs/development) +Refer to the [project website](https://tori.jutty.dev) for updates and access to [documentation](https://tori.jutty.dev/docs). ## Installation 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 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: - `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 - `version`: print the current version and its release date