From 50abef7b54386996d2b619679c485fa9d522a735 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 2 Oct 2017 23:21:27 -0700
Subject: add notes about updating firmware and libraries to the README

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b250137..72affb1 100644
--- a/README.md
+++ b/README.md
@@ -74,11 +74,36 @@ Click the Upload button or press `Ctrl-U`.
 Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins.
 
 
-
-# Start to customize the firmware.
+# Start to customize the firmware
 
 You can customize your keyboard's key layout and LED effects by modifying the `Model01-Firmware.ino` file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc.
 
+
+# Updating the firmware and libraries
+
+From time to time, you may want to pull the latest version of this firmware from GitHub. To do that, navigate to the Model01-Firmware directory in your shell and pull the latest code.
+
+```sh
+cd Model01-Firmware
+git pull
+```
+
+After that, you'll want to update the Kaleidoscope libraries.
+
+### MacOS
+```sh
+cd $HOME/Documents/Arduino/hardware/keyboardio/avr
+make update-submodules
+```
+
+### Linux
+
+```sh
+cd $HOME/Arduino/hardware/keyboardio/avr
+make update-submodules
+```
+
+
 # Getting help
 
 As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.
-- 
cgit v1.2.3