home/README.md

# home

Hi there! This repository contains all of my (publically available) `$HOME` files. This is mainly meant as a utility for my own use, but if you'd like to base your configs on mine for some reason, feel free!

This repository contains submodules, make sure to clone those as well with the following command:

```sh
git clone --recursive-submodules https://www.coastalcommits.com/Seaswimmer/home.git
```

Or, if you've already cloned the repository, initialize the submodules with the following command:

```sh
git submodules update --recursive
```

## Notes

- `.zshc/aliases.sh` contains aliases for `nano`, `vim`, and `vi`. If you use any of these editors, you may want to change these aliases before reloading your shell.
- If you are not an Arch Linux user, you will want to change the following things:
  - `.zshc/aliases.sh`: Remove the `aur` alias.
  - `.zhsrc`: Replace the `archlinux` plugin with the [oh-my-zsh plugin(s) for your distrubtion](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins-Overview#distro-related).
added README.md Signed-off-by: Seaswimmer <seaswimmerthefsh@gmail.com> 2024-07-10 11:58:16 -04:00			`# home`

			Hi there! This repository contains all of my (publically available) `$HOME` files. This is mainly meant as a utility for my own use, but if you'd like to base your configs on mine for some reason, feel free!
added a missing newline to the README Signed-off-by: Seaswimmer <seaswimmerthefsh@gmail.com> 2024-07-10 12:00:40 -04:00
fixed README formatting and added another command Signed-off-by: Seaswimmer <seaswimmerthefsh@gmail.com> 2024-07-10 12:00:00 -04:00			`This repository contains submodules, make sure to clone those as well with the following command:`

			```sh
			`git clone --recursive-submodules https://www.coastalcommits.com/Seaswimmer/home.git`
			```

			`Or, if you've already cloned the repository, initialize the submodules with the following command:`

			```sh
			`git submodules update --recursive`
			```
added notes section to the README 2024-07-10 12:19:11 -04:00
			`## Notes`

			- `.zshc/aliases.sh` contains aliases for `nano`, `vim`, and `vi`. If you use any of these editors, you may want to change these aliases before reloading your shell.
			`- If you are not an Arch Linux user, you will want to change the following things:`
			- `.zshc/aliases.sh`: Remove the `aur` alias.
			- `.zhsrc`: Replace the `archlinux` plugin with the [oh-my-zsh plugin(s) for your distrubtion](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins-Overview#distro-related).