aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordiogo464 <[email protected]>2022-09-23 13:45:57 +0100
committerdiogo464 <[email protected]>2022-09-23 13:45:57 +0100
commite5a38bab67f790803ff98484fc5835adba7bf62a (patch)
treef93bc54b128db58c3e84c0db8908dda729222dc7 /README.md
parente28be1bbe34e5430333d5bb95437e75bcfaf2edb (diff)
rewrite
Diffstat (limited to 'README.md')
-rw-r--r--README.md77
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
2A 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
10Example 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
28Running `dotup init` will create an empty depot file in the current directory(by default).
29```
30$ dotup init
31```
32A new file, `depot.toml`, should have been created in the current directory.
33
34### dotup link
35The `link` subcommand can be used to tell where a file should be linked when installed.
36Running `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`
39This 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
41To link a directory use the flag `--directory`.
42```
43$ dotup link --directory scripts .scripts
44```
45This will create a new link
46+ `scripts` -> `.scripts`
47
48### dotup unlink
49The `unlink` subcommand unlinks files.
50```
51$ dotup unlink nvim/lua/setup.lua
52```
53will remove the link `nvim/lua/setup.lua` -> `.config/nvim/lua/setup.lua`.
54
55### dotup install
56The `install` subcommand creates symlinks.
57Like the `link` subcommand passing a directory as argument will recursively install anything under it, files and directories.
58
59By 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```
63will 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```
70will create one symlink
71+ `scripts` -> `$HOME/.scripts`
72Any new scripts added to `$HOME/.scripts` will be created at `configs/scripts`.
73
74### dotup uninstall
75The `uninstall` subcommand removes the symlinks.
76This will only remove symlinks if they were pointing to the correct file.
77