diff options
| author | Max Bossing <info@maxbossing.de> | 2025-07-16 12:13:11 +0200 | 
|---|---|---|
| committer | Max Bossing <info@maxbossing.de> | 2025-07-16 12:13:11 +0200 | 
| commit | 957c938ae120ea2cea4bb5fcbe4d2e06e307e14a (patch) | |
| tree | 5f5f8306f85300eabf805d7d58c8886d09ab9374 /README.md | |
| parent | 93425791b198028999f13102705091bee7f9a1e3 (diff) | |
docs: update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 | 
1 files changed, 12 insertions, 5 deletions
| @@ -15,10 +15,17 @@ appropriate option for your system. `dots` currently only supports linux, but in  To build from source, simply clone and run `cargo build --release`. +## Usage + +At the core, `dots` just symlinks arbitrary files and directories as specified by a configuration file. Refer to the [dots.toml](#dotstoml) section for an example. + +To deploy a set of files, use `dots deploy`. + +If you want to un-deploy a set of dots (removing the links created), you can use `dots unlink` +  ## dots.toml -At the core, `dots` just symlinks arbitrary files and directories as specified by a configuration file. By default, `dots` -will look for a `dots.toml` file in the current directory. +By default, `dots` will look for a `dots.toml` file in the current directory.  Example `dots.toml`:  ```toml @@ -41,11 +48,11 @@ dest = ".tmux.conf"  If you want to use a different file (for example a different machine but based on the same files), pass a path to the executable  ```bash -dots some_file.dots.toml +dots deploy --config some_file.dots.toml  ```  ## Todo -- [ ] Allow to "undeploy", eg. to automatically remove symlinks created by `dots` +- [x] Allow to "undeploy", eg. to automatically remove symlinks created by `dots`  ## License -This is licensed under the [MIT](LICENSE) license.
\ No newline at end of file +This is licensed under the [MIT](LICENSE) license. | 
