diff --git a/README.md b/README.md index a7ed3b0..c5a4993 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,35 @@ +# Dotfiles + +My personal dotfiles for reproducing my entire machine. + +Includes + +- Operating System and packages (NixOS) +- Neovim config +- Ghostty Terminal config +- Tmux config +- Utility scripts ## Installation -To install GNU Stow, use your preferred package manager +Use your preferred package manager to install GNU stow -### OpenSUSE Tumbleweed +Then clone the repository -```zsh -$ sudo zypper up -$ sudo zypper in stow +```sh +$ git clone https://github.com/kyren223/dotfiles ``` -### Load (symlink) dotfiles +Let stow generate all the symlinks for you -- - refers to the name of the directory where the dotfiles git repo lives -Make sure that is a subdirectory of `$HOME` - -```zsh -$ cd ~/ && stow . +```sh +$ cd ~/dotfiles && stow . ``` -You may need to add the `--adopt` flag to stow to override existing configurations in `$HOME` -```zsh -$ cd ~/ && stow --adopt . +You may need to add the `--adopt` flag to stow to override existing your existing dotfiles. + +If using NixOS, rebuild your system using the flake + +```sh +$ sudo nixos-rebuild switch --flake ~/dotfiles#laptop-nixos ``` - -## Usage - -- - refers to the name of the directory where the dotfiles git repo lives -- - The directory path where the file/s live -- - The file's name, this is the file you want to add/update/delete - -### Add - -Add a new file to the dotfiles repo - -```zsh -$ mv ~// ~/// -$ cd ~/ && stow . -``` - -### Update - -As GNU Stow uses symlinks, you can simply edit it (in either ~// or ~///) and the changes will be present in both locations - -### Delete - -Remove a file from GNU Stow and the filesystem - -```zsh -$ rm ~/// -$ rm ~// -``` - -Remove a file only from GNU Stow, but keep it in the filesystem - -```zsh -$ rm ~// -$ mv ~/// ~// -$ cd ~/ && stow . -``` - -### Commit changes to the GitHub repository (optional) - -```zsh -$ cd ~/ -$ git add . -$ git commit -m "Your message here" -$ git push origin master -``` - -### Pull Changes from the GitHub repository - -```zsh -$ cd ~/ -$ git pull origin master -$ stow -- adopt . -``` - - - -