docs: add basic usage

vidavidorra · May 11, 2024 · a4f3eb0 · a4f3eb0
1 parent 01139e1
commit a4f3eb0
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,12 @@ $ ./bootstrap
 
 ## Usage
 
-TBD
+To update the dotfiles locally, pull the latest changes from GitHub and run the bootstrap script again. The `NO_MACOS` environment variable can be used to skip the macOS settings, e.g. `NO_MACOS=1 ./bootstrap`.
+
+```shell
+$ git pull
+$ ./bootstrap
+```
 
 ## Contributing
 

diff --git a/bootstrap b/bootstrap
@@ -54,7 +54,9 @@ install_homebrew() {
 
 install_software() {
   echo " INFO: installing software with Homebrew Bundle"
-  HOMEBREW_COLOR=1 brew bundle --quiet \
+  HOMEBREW_COLOR=1 brew bundle \
+    --file="macos/Brewfile" \
+    --quiet \
     | sed -u '/^Using/d' \
     | sed -u 's/^/       /'
 }
@@ -68,7 +70,7 @@ source python/install
 source zsh/install
 
 if [ -z "${NO_MACOS}" ]; then
-  source macos
+  source macos/settings
 fi
 
 exit 0
diff --git a/Brewfile → macos/Brewfile b/Brewfile → macos/Brewfile
diff --git a/macos → macos/settings b/macos → macos/settings