PeterCxy/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add README

Browse source
This commit is contained in:
Peter Cai 2021-11-18 18:53:05 -05:00
parent 338d88e54a
commit b240b262e9
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md Normal file
View file

@ -0,0 +1,14 @@
PeterCxy's Dotfiles
---
These files are supposed to be installed by GNU Stow. For example, if you want to install the dotfiles for `sway` listed in this directory, then clone this repository to your `$HOME`, and then run
```bash
stow sway
```
which will automatially create all the symlinks needed.
All subdirectories (except `fonts`) in this repository are structured with the assumption that you are going to put the repository directly in `$HOME`. If not, you need to change the command for `stow` accordingly.
Note that to install `fonts`, you need `sudo stow -t / fonts` instead.