From f5254600c694ba0bc360af417336282f25f45ca3 Mon Sep 17 00:00:00 2001
From: Jesse Vincent <jesse@keyboard.io>
Date: Mon, 14 Aug 2017 15:45:07 -0700
Subject: Reorganize makefile to avoid suggestions that Arduino lets you
 customize your sketchbook directory

---
 README.md | 54 +++++++++++++++++++++++++++++-------------------------
 1 file changed, 29 insertions(+), 25 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8b97353..dea8b9f 100644
--- a/README.md
+++ b/README.md
@@ -2,52 +2,56 @@
 
 Flexible firmware for Arduino-powered keyboards
 
-# Getting Started
 
-Pick a directory to work in, you'll need to clone multiple repositories. We'll assume you picked `$HOME/kaleidoscope`, if you chose another adapt the commands below accordingly.
-
-## Setup the Arduino IDE
+# Set up the Arduino IDE
 
 Setup the Arduino IDE on your system. Make sure you install at least version 1.6, since older version may not support all required features.
 
-* On Linux, follow the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Arduino-Setup-Linux), installing the Arduino package somewhere that 'arduino' and 'arduino-builder' end up in your $PATH
-* On macOS, install using [homebrew](http://brew.sh/) [cask](https://caskroom.github.io/) with `brew cask install arduino` or download the application from [the official website](https://www.arduino.cc/en/Main/Software) and move it to your `/Applications` folder.
+# macOS
 
-## Install the Kaleidoscope Hardware Definitions
+On macOS, install the Arduino IDE using [homebrew](http://brew.sh/) [cask](https://caskroom.github.io/) with `brew cask install arduino` or download the application from [the official website](https://www.arduino.cc/en/Main/Software) and move it to your `/Applications` folder.
 
-```sh
-# You'll need to know your arduino sketchbook directory
+## Linux
 
-# on macOS the default is
-SKETCHBOOK_DIR=$HOME/Documents/Arduino
-# on Linux the default is
-SKETCHBOOK_DIR=$HOME/Arduino
+On Linux, your distribution's package manager probably includes the Arduino IDE, but it may be an out of date version. If your distribution installs a version of Arduino before 1.6.3 or so, you'll need to install the Arduino IDE following the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Arduino-Setup-Linux), installing the Arduino package somewhere that 'arduino' and 'arduino-builder' end up in your $PATH
 
-# Make a directory for the Arduino sketchbook and our hardware definitions
-mkdir -p $SKETCHBOOK_DIR/hardware/keyboardio
+# Create and navigate to the Arduino Sketchbook directory
 
-# then clone the hardware definitions to make them available to the arduino environment
-git clone --recursive https://github.com/keyboardio/Arduino-Boards.git $SKETCHBOOK_DIR/hardware/keyboardio/avr
+## MacOS
+```sh
+mkdir -p $HOME/Documents/Arduino
+cd $HOME/Documents/Arduino 
+```
+
+## Linux
+
+```sh
+mkdir -p $HOME/Arduino
+cd $HOME/Arduino 
 ```
 
-## Clone and Build the Kaleidoscope Firmware for the Model 01
+# Download hardware platform, library source code and firmware source code
 
 ```sh
-# go to your Arduino sketchbook
-cd $SKETCHBOOK
+mkdir -p hardware/keyboardio
+
+# then clone the hardware definitions to make them available to the arduino environment
+git clone --recursive https://github.com/keyboardio/Arduino-Boards.git hardware/keyboardio/avr
 
 # then clone the firmware repository
 git clone https://github.com/keyboardio/Model01-Firmware.git
+````
 
-# and build your firmware!
-cd Model01-Firmware
 
-make flash
+# Build and flash the firmware from the commandline!
 
-# When the builder tells you to hit return to continue,
-# hold down "prog" on your keyboard and hit return.
+```sh
+cd Model01-Firmware
+make flash
 ```
 
+When the builder tells you to hit Enter to continue, hold down "Prog" on your keyboard and hit Enter.
+
 <3 jesse
 
 [![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware)
-- 
cgit v1.2.3