dotfiles/README.md

24 lines
870 B
Markdown

# dotfiles
Universal config files for my linux desktop environments. Managed with GNU stow
# Installation
## Submodules
This repo contains submodules. These are not pulled with the default clone command. Initialise them with:
```sh
git submodule update --init
```
or clone the repo with them:
```sh
git clone --recurse-submodules https://git.codebased.xyz/bytequill/dotfiles.git
```
## Applying config
Using [GNU Stow](https://www.gnu.org/software/stow/) you can easily apply configs provided by this repo
You can either run the script `stow.sh` or execute the below manually:
```sh
stow --target $HOME .
```
# note
## .oh-my-zsh inclusion
I would rather not have included the `.oh-my-zsh` submodule in this repo, however the official install script overwrites `.zshrc` and I wanted a plug-and-play experience without having to do any manual intervention/extra steps