Skip to content

Commit

Permalink
docs: add install mode instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeTRogers committed Mar 11, 2024
1 parent 116abe5 commit c5c9d91
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,16 @@ This repo manages my dotfiles and works nicely with the vscode dev container ext

## Installation

The installation process is handled by the `install.sh` script. Run this script to install and configure all the dotfiles. You should for this repo and adjust it to your needs before running the script.
The installation process is handled by the `install.sh` script. It has 2 install modes:

- `./install.sh` - without any arguments, it performs a minimal installation intended for devcontainers, skipping:
- `.gitconfig`
- `tmux`
- `vim`
- `./install.sh full` - with the `full` argument, it will perform a full installation intended for a jump server/workstation.

> [!NOTE]
> You should fork this repo and adjust it to your needs before running the script.
## credit

Expand Down

0 comments on commit c5c9d91

Please sign in to comment.