fix spelling mistake, update docs
This commit is contained in:
parent
687d333d3f
commit
ae58186d45
25
README.md
25
README.md
@ -1,12 +1,14 @@
|
|||||||
# My dotfiles
|
# My dotfiles
|
||||||
|
|
||||||
|
A collection of my config files (also known as dotfiles).
|
||||||
|
|
||||||
I am using [GNU Stow](https://www.gnu.org/software/stow/) to symlink
|
I am using [GNU Stow](https://www.gnu.org/software/stow/) to symlink
|
||||||
my dotfiles to their correct locations in my `$HOME` directory.
|
my dotfiles to their correct locations in my `$HOME` directory.
|
||||||
|
|
||||||
## Cloning this repo
|
## Cloning this repo
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/lemonase/dotfiles.git && cd dotfiles/config
|
git clone https://github.com/lemonase/dotfiles.git
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing `stow` on Linux and macOS
|
## Installing `stow` on Linux and macOS
|
||||||
@ -25,6 +27,26 @@ pacman -S stow
|
|||||||
brew install stow
|
brew install stow
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Using `install.sh` script
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ ./install.sh --help
|
||||||
|
dotfile symlink install script:
|
||||||
|
options:
|
||||||
|
|
||||||
|
install, i:
|
||||||
|
install dotfile symlinks to $HOME directory
|
||||||
|
|
||||||
|
uninstall, u, delete, d, remove, r:
|
||||||
|
uninstall dotfile symlinks to $HOME directory
|
||||||
|
|
||||||
|
repair, r:
|
||||||
|
repair old dotfile symlinks
|
||||||
|
|
||||||
|
list, l:
|
||||||
|
list symlinks files in home directory
|
||||||
|
```
|
||||||
|
|
||||||
## Using `stow`
|
## Using `stow`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -57,4 +79,3 @@ WARNING! stowing git would cause conflicts:
|
|||||||
|
|
||||||
Delete or move file in question
|
Delete or move file in question
|
||||||
|
|
||||||
---
|
|
||||||
|
|||||||
11
install.sh
11
install.sh
@ -6,17 +6,20 @@ CONFIG_DIR="$(dirname "$0")/config"
|
|||||||
cd $CONFIG_DIR
|
cd $CONFIG_DIR
|
||||||
|
|
||||||
if [[ "$1" == "help" || "$1" == "--help" || "$1" == "-h" ]]; then
|
if [[ "$1" == "help" || "$1" == "--help" || "$1" == "-h" ]]; then
|
||||||
echo "dofiles install script with stow:"
|
echo "dotfile symlink install script:"
|
||||||
echo "options:"
|
echo "options:"
|
||||||
echo ""
|
echo ""
|
||||||
echo "install, i:"
|
echo "install, i:"
|
||||||
echo " install dotfiles"
|
echo " install dotfile symlinks to $HOME directory"
|
||||||
echo ""
|
echo ""
|
||||||
echo "uninstall, u, delete, d, remove, r:"
|
echo "uninstall, u, delete, d, remove, r:"
|
||||||
echo " uninstall dotfiles"
|
echo " uninstall dotfile symlinks to $HOME directory"
|
||||||
echo ""
|
echo ""
|
||||||
echo "repair, r:"
|
echo "repair, r:"
|
||||||
echo " repair dotfile symlinks"
|
echo " repair old dotfile symlinks"
|
||||||
|
echo ""
|
||||||
|
echo "list, l:"
|
||||||
|
echo " list symlinks files in home directory"
|
||||||
exit
|
exit
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user