Merge pull request #30 from PunchThrough/release/1.7.0

release: current release –> 1.7.0

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "hardware/bean/avr/cores/bean/applicationMessageHeaders"]
 	path = hardware/bean/avr/cores/bean/applicationMessageHeaders
-	url = https://bitbucket.org/punchthroughdesign/bean-application-message-definitions.git
+	url = [email protected]:punchthroughdesign/bean-application-message-definitions.git
+[submodule "hardware/bean/avr/libraries/PinChangeInt"]
+	path = hardware/bean/avr/libraries/PinChangeInt
+	url = https://github.com/PunchThrough/PinChangeInt.git

README.md

@@ -1,10 +1,29 @@
-# [LightBlue Bean](https://punchthrough.com/bean) Arduino Library
+Bean - A BLE Arduino By Punch Through Design
+=============================================
+
+Repo Overview
+-------------
 
 This repo contains the Arduino firmware and installation files used in the LightBlue Bean project. The firmware files are based off of the Arduino firmware release version 1.0.5 and have been modified to work on the LightBlue Bean, a system that has on it a few other features, a BLE radio an accelerometer and a multicolor LED.
 
-# Reading and Setting Atmega Fuses with avrdude
+### TODO:
+
+* Add note to this doc regarding FUSES (!! BOD)
+* Fix Serial.println so, like Serial.print, extra radio messages arn't sent for the newline
+* Add proper doxygen comments to relelvent parts, especially the API
+* Add features to emulator to provide better, more useful testing
+* Add more and better examples
+
+### Reading and Setting Atmega Fuses with avrdude
+
+We're going to need to set some fuses for our part in the factory.  The fuse settings we need are going to set our part to basically should
+match the Arduino Pro defaults with brownout disabled.
+
+At the time of writing, I don't have a programmer at my disposal.  However the steps taken should be the 
+We write the fuse settings here: XX XX XX
+
+Steps:
 
-We're going to need to set some fuses for our part in the factory.  The fuse settings we need are going to set our part to basically should match the Arduino Pro defaults with brownout disabled.
 
 1. Install avrdude.  I used [http://www.obdev.at/products/crosspack/index.html](CrossPack) to do this.
 1. Read the fuses from an off the shelf ArduinoPro.  Use this command after avrdude is in your path: `avrdude -p atmega328p -c usbtiny -U lfuse:r:-:h -U hfuse:r:-:h -U efuse:r:-:h -U lock:r:-:h`
@@ -13,21 +32,20 @@ We're going to need to set some fuses for our part in the factory.  The fuse set
 1. Calculate the new state of the fuses using the website, note for future (so no one else has to do these silly instructions)
 1. Use avrdude to write and test your new fuse settings.  The command line will look something like this (except, these are guessed values: `avrdude -p atmega328p -c usbtiny -U lfuse:w:0xee:m -U hfuse:w:0xdc:m -U efuse:w:0xff:m`)
 
-# Key Files
 
-## Everything in the `hardware` directory
 
-The contents of the hardware directory should be copied into the Arduino program resources hardware directory on install.  This directory contains the firmware for the LightBlue Bean, as well as the files needed for the Arduino IDE to recognize the board allow users to program it.
+### Key Files:
 
-## Everything in the `examples` directory
+#### Everything in the `hardware` directory
+The contents of the hardware directory should be copied into the Arduino program resources hardware directory on install.  This directory contains the firmware for the LightBlue Bean, as well as the files needed for the Arduino IDE to recognize the board allow users to program it.
 
+#### Everything in the `examples` directory
 The contents of the examples directory should be copied separately on install to the examples resources in the Arduino IDE.
 
-## Everything in the `beanModuleEmulator` directory
-
+#### Everything in the `beanModuleEmulator` directory
 This directory contains an Emulator of the 'non-Arduino' parts of the bean.  This acts as a test jig for the Arduino code, and allows us to verify that things operate as expected.  You can run `python BeanModuleEmulator.py` from within the beanModuleEmulator directory.
 
-# Dependencies
+##### Dependencies
 
 There are a few python library dependencies you'll need to make the emulator work:
 
@@ -38,86 +56,19 @@ There are a few python library dependencies you'll need to make the emulator wor
 
 The emulator has been tested with python 2.7.6 installed by Homebrew on OSX
 
-# Development
-
+### Development:
 During development, it is recommended to use soft links from inside your Arduino IDE resources to your repository.  It will make it easier to test your work.
 
-# Repo Setup
-
-This repository uses git submodules and requires a few extra steps for cloning and pulling.
-
-## Clone
-
-```
-$ git clone REPO_URL --recursive
-```
-
-## Initialize Submodules 
-
-(This is unnecessary if the recursive clone works)
-
-```
-$ git submodule update --init --recursive
-```
-
-## Pull
-
-```
-$ git pull
-$ git submodule update --recursive
-```
-
-# Code Style and Quality
+### Repo Setup:
+This repository uses git submodules and requires a few extra steps for cloning and pulling. 
+#### Clone
+		git clone REPO_URL --recursive
 
-Code in this repo should adhere to the [Google C++ Style Guide](https://google-styleguide.googlecode.com/svn/trunk/cppguide.html).
+#### Initialize Submodules 
+######(This is unnecessary if the recursive clone works)
+		git submodule update --init --recursive
 
-This repo comes with tools to ensure your code meets Punch Through C++ style guidelines.
-
-If code you submit for review does not fit our style guide, your pull request will fail our automated tests. Lint your code before submitting it to avoid this.
-
-## Installing Tools
-
-If you're running the reformatter or linter for the first time, run this first to install the tools:
-
-```sh
-make install
-```
-
-## Auto-Reformat
-
-clang-format is set up to use the Google style guide. Reformatting your code will clean up many of the lint errors you might make.
-
-To reformat Bean files in this project:
-
-```sh
-make reformat
-```
-
-clang-format uses the `.clang-format` file to set formatting style. See the [clang-format docs](http://clang.llvm.org/docs/ClangFormat.html) for more info.
-
-## Linting
-
-Our continuous integration server lints all code when it's submitted to a pull request. You can run the linter on your machine to make sure your code is up to this repo's standards.
-
-To lint Bean files for errors before committing:
-
-```sh
-make lint
-```
-
-cpplint is configured in `CPPLINT.cfg`. See the [cpplint.py source](https://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py) for more info on configuration options and linter filters.
-
-## View List of Linted Files
-
-To see which files will be linted or reformatted:
-
-```sh
-make show
-```
-
-# TODO
-
-* Fix Serial.println so, like Serial.print, extra radio messages aren't sent for the newline
-* Add proper doxygen comments to relelvent parts, especially the API
-* Add features to emulator to provide better, more useful testing
-* Add more and better examples
+#### Pull
+		git pull
+		git submodule update --recursive
+