Skip to content

Commit

Permalink
Merge branch 'chore/update-readme'
Browse files Browse the repository at this point in the history
  • Loading branch information
tainvecs committed Dec 21, 2024
2 parents 136de43 + 3a889d0 commit 150224c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Install dotfiles by running the `curl` or `wget` command in the terminal.
| **wget** | `sh -c "$(wget -O- https://raw.githubusercontent.com/tainvecs/dotfiles/main/scripts/install.zsh)"` |

In addition, the following environment variables are configurable for the dotfiles installation scripts.
| Environment Variables | Default | Descriptions |
| Environment Variable | Default | Description |
|:------------------------------------------|:-----------------|:--------------------------------------------------------------------|
| **DOTFILES_ROOT_DIR** | `$HOME/dotfiles` | The customized root folder for dotfiles repo. |
| **DOTFILES_APPLY_LOCAL_CONFIG_TEMPLATES** | `''` | Set to `true` to apply template configs in `local/config_template`. |

To run the installation script with these variables, try the following command.
To run the installation script with these variables, try the following commands.
| Method | Command |
|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **curl** | `env DOTFILES_ROOT_DIR=/customized_path/dotfiles DOTFILES_APPLY_LOCAL_CONFIG_TEMPLATES=true sh -c "$(curl -fsSL https://raw.githubusercontent.com/tainvecs/dotfiles/main/scripts/install.zsh)"` |
Expand All @@ -41,14 +41,15 @@ To test this package and tune your local config, pull the docker image and run i
docker pull ghcr.io/tainvecs/dotfiles:latest
docker run --rm -it ghcr.io/tainvecs/dotfiles:latest
```

Alternatively, you can also build the image locally.
```zsh
cd /customized_path/dotfiles && sh ./deployment/docker_build_local.sh
```


## Uninstallation
Simply remove the following command from your `~/.zshenv` file
Simply remove the following command from your `~/.zshenv` file.
```zsh
source /customized_path/dotfiles/config/zsh/.zshenv
```
Expand Down

0 comments on commit 150224c

Please sign in to comment.