diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index af77721..0000000 --- a/README.md +++ /dev/null | |||
| @@ -1,77 +0,0 @@ | |||
| 1 | # dotup | ||
| 2 | A CLI tool to help symlink your dotfiles into place. | ||
| 3 | |||
| 4 | ## Installation | ||
| 5 | ``` | ||
| 6 | $ cargo install --git https://github.com/diogo464/dotup | ||
| 7 | ``` | ||
| 8 | |||
| 9 | ## Usage | ||
| 10 | Example file hierarchy with dotfiles. | ||
| 11 | ``` | ||
| 12 | configs | ||
| 13 | nvim/ | ||
| 14 | init.vim | ||
| 15 | lua/ | ||
| 16 | setup.lua | ||
| 17 | alacritty/ | ||
| 18 | alacritty.yml | ||
| 19 | bash/ | ||
| 20 | .bashrc | ||
| 21 | scripts/ | ||
| 22 | script1.sh | ||
| 23 | script2.sh | ||
| 24 | script3.sh | ||
| 25 | ``` | ||
| 26 | |||
| 27 | ### dotup init | ||
| 28 | Running `dotup init` will create an empty depot file in the current directory(by default). | ||
| 29 | ``` | ||
| 30 | $ dotup init | ||
| 31 | ``` | ||
| 32 | A new file, `depot.toml`, should have been created in the current directory. | ||
| 33 | |||
| 34 | ### dotup link | ||
| 35 | The `link` subcommand can be used to tell where a file should be linked when installed. | ||
| 36 | Running `dotup link nvim .config/nvim` will create two new links: | ||
| 37 | + `nvim/init.vim` -> `.config/nvim/init.vim` | ||
| 38 | + `nvim/lua/setup.lua` -> `.config/nvim/lua/setup.lua` | ||
| 39 | This subcommand will, by default, only link files. If a directory is passed as argument then it will recursively link all files under that directory. | ||
| 40 | |||
| 41 | To link a directory use the flag `--directory`. | ||
| 42 | ``` | ||
| 43 | $ dotup link --directory scripts .scripts | ||
| 44 | ``` | ||
| 45 | This will create a new link | ||
| 46 | + `scripts` -> `.scripts` | ||
| 47 | |||
| 48 | ### dotup unlink | ||
| 49 | The `unlink` subcommand unlinks files. | ||
| 50 | ``` | ||
| 51 | $ dotup unlink nvim/lua/setup.lua | ||
| 52 | ``` | ||
| 53 | will remove the link `nvim/lua/setup.lua` -> `.config/nvim/lua/setup.lua`. | ||
| 54 | |||
| 55 | ### dotup install | ||
| 56 | The `install` subcommand creates symlinks. | ||
| 57 | Like the `link` subcommand passing a directory as argument will recursively install anything under it, files and directories. | ||
| 58 | |||
| 59 | By default install will use the home directory as the install-base but this can be changed with the `--install-base <path>` parameter. | ||
| 60 | ``` | ||
| 61 | $ dotup install nvim | ||
| 62 | ``` | ||
| 63 | will create two symlinks | ||
| 64 | + `nvim/init.vim` -> `$HOME/.config/nvim/init.vim` | ||
| 65 | + `nvim/lua/setup.lua` -> `$HOME/.config/nvim/lua/setup.lua` | ||
| 66 | |||
| 67 | ``` | ||
| 68 | $ dotup install scripts | ||
| 69 | ``` | ||
| 70 | will create one symlink | ||
| 71 | + `scripts` -> `$HOME/.scripts` | ||
| 72 | Any new scripts added to `$HOME/.scripts` will be created at `configs/scripts`. | ||
| 73 | |||
| 74 | ### dotup uninstall | ||
| 75 | The `uninstall` subcommand removes the symlinks. | ||
| 76 | This will only remove symlinks if they were pointing to the correct file. | ||
| 77 | |||