diff --git a/README.md b/README.md index c2485e8b5..bd1680053 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,27 @@ ## How to use +### On Linux + 1. `cd ~` 2. `git clone https://github.com/jan-revay/initPC.git` 3. `cd initPC/` -4. `git checkout ` (optional, default is the branch stable) +4. `git checkout ` (optional, default is the branch `devel`) 5. `./run_init.sh` (a platform-independent init script launcher) Note: Logs will appear in the folder `initPC/Logs/`. Use `cat ` to display a log file with the original VT100 colors. After you updated the `initPC` or `dotfiles` repo (e.g. adding a package, changing a config file, or adding an alias...), run the `refresh` command from Bash to apply the config change to the machine. +### On Windows + +1. `cd ~` +2. `git clone https://github.com/jan-revay/initPC.git` +3. `cd initPC` +4. `git checkout ` (optional, default is the branch `devel`) +5. `cd Windows_10` +6. `.\run_all.ps1` + ## Branches 1. **minimal** - debloated, stable, tested, production-ready, and not expected to change in the _yearly horizon_. Only necessary stuff. Possibly useful for detecting whether bugs in the stable branch are caused by the init script or to be used as a substitute for the stable branch while the stable branch has a critical bug.