From b240b262e99af400124501eac5e011cc95525393 Mon Sep 17 00:00:00 2001 From: Peter Cai Date: Thu, 18 Nov 2021 18:53:05 -0500 Subject: [PATCH] add README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..370c33c --- /dev/null +++ b/README.md @@ -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.