Merge pull request #25 from mcci-catena/issue24

Fix #24: prepare for v1.2.0 release

README.md

@@ -5,25 +5,65 @@ for MCCI Catena IoT devices.  It is based on the Arduino core
 for Atmel's SAMD21 processor (used on the Arduino/Genuino Zero, MKR1000 and MKRZero boards),
 as extended by Adafruit for their SAMD Boards such as the Feather M0.
 
-[![GitHub release](https://img.shields.io/github/release/mcci-catena/ArduinoCore-samd.svg)](https://github.com/mcci-catena/ArduinoCore-samd/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/ArduinoCore-samd/latest.svg)](https://github.com/mcci-catena/ArduinoCore-samd/compare/v1.1.0...master)
+[![GitHub release](https://img.shields.io/github/release/mcci-catena/ArduinoCore-samd.svg)](https://github.com/mcci-catena/ArduinoCore-samd/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/ArduinoCore-samd/latest.svg)](https://github.com/mcci-catena/ArduinoCore-samd/compare/v1.2.0...master)
 
 **Contents:**
 <!-- TOC depthFrom:2 updateOnSave:true -->
 
-- [Installation on Arduino IDE](#installation-on-arduino-ide)
+- [Installing this Package](#installing-this-package)
+	- [Installing from the IDE](#installing-from-the-ide)
+	- [Installing a Development Copy of this BSP](#installing-a-development-copy-of-this-bsp)
 - [Bugs or Issues](#bugs-or-issues)
 - [Release History](#release-history)
 - [License and credits](#license-and-credits)
 	- [LGPL License](#lgpl-license)
 	- [Trademark Acknowledgements](#trademark-acknowledgements)
 
 <!-- /TOC -->
-## Installation on Arduino IDE
 
-Simply install the package following the instructions given here:
+## Installing this Package
+
+### Installing from the IDE
+
+The easy approach is to install the package following the instructions given here:
 
 https://github.com/mcci-catena/arduino-boards/blob/master/README.md
 
+However, if you need to development, it's more complicated. See the following section.
+
+### Installing a Development Copy of this BSP
+
+If you want to develop and test changes to this package, we suggest the following.
+
+1. Install the current release from the standard location using the Arduino `Tools>Boards>Boards Manager...` menu. This installs tools and so forth.
+2. Select a board supported by this package.
+3. Create an empty sketch with Arduino `File>New`, and check that you can build.
+4. Close the Arduino IDE.
+5. Clone this repo to a convenient spot on your computer.
+6. Open a command window and go to the Arduino board installation directory. It will be one of the following.
+
+   | System | Location |
+   |:------:|:---------|
+   | Windows 7 through 10 | <code>c:\Users\\<em><strong>username</strong></em>\AppData\Local\Arduino15</code>. If you're using git bash, you can also use `~/AppData/Local/Arduino15` |
+   | macOS | <code>~/Library/Arduino15</code> |
+   | Linux | <code>~/.arduino15</code> |
+
+7. From this location, change directory to `packages/mcci/samd`.
+8. Look at the direcory contents with `ls`. You'll see a directory named like a version number, for example `1.2.0`.
+9. Move the directory you just found away from the `samd` directory. It's convenient to have it around, so we sugest not delete it.
+10. Create a symbolic link to the sandbox you created in step (3) above. On macOS and Linux, this is done using the `ln -s` command. On Windows 10, this is done with the `mklink /d` command. (On older versions of Windows, unless you're very experienced, you might want to use a Linux VM in VirtualBox -- we can't advise on the best way to do this.)
+
+    - On any system you can also simply move the old directory out of the way, and then move your sandbox in. The old directory cannot simply be renamed `packages/mcci/samd`, but it can be put (for example) in `packages/mcci/hide-samd-1.2.0` (or whatever version it was). After moving the old directory away, you can move the repo that you cloned in step 5, above, into the `packages/mcci/samd` directory using a suitable version number.
+
+11. Open the Arduino IDE.
+12. Use the menu `File>New` to create an empty sketch (or reuse the sketch from step 3).
+13. Make sure the board you want to develop for is selected in `Tools>Boards`.
+14. Make changes and build.
+
+Remember to restart the IDE whenever you change `platform.txt`, `boards.txt` or `programmers.txt`.
+
+**Caution:** If you update your BSP from the IDE, your changes may be discarded.
+
 ## Bugs or Issues
 
 If you find a bug you can submit an issue here on github:
@@ -43,12 +83,14 @@ to avoid duplicates.
 
 ## Release History
 
-- v1.1.0 adds support for the MCCI Catena 4420 and 4470. It also adds the ability to select the target LoRaWAN region from the IDE Tools menu (assuming that you're using the [MCCI Catena arduino-lmic](https://github.com/mcci-catena/arduino-lmic) library). It also fixes the USB product ID numbers to match the official numbers assigned by MCCI release engineering (issue [#9](https://github.com/mcci-catena/ArduinoCore-samd/issues/9)).
+- [v1.2.0](https://github.com/mcci-catena/ArduinoCore-samd/releases/tag/v1.2.0) adds several features. It moves flags in the link script to accomodate the BME680 BSEC library. It adapts the JSON templating system from the [MCCI STM32 BSP](https://github.com/mcci-catena/Arduino_Core_STM32). The `millis()` routine was updated so that the clock value will advance even if interrupts are disabled (issue [#17](https://github.com/mcci-catena/ArduinoCore-samd/issues/16)). Properly define the country code for as923jp (issue [#13](https://github.com/mcci-catena/ArduinoCore-samd/issues/13)). Fix typo `au915` should have been `au921`(issue [#12](https://github.com/mcci-catena/ArduinoCore-samd/issues/12)).
+
+- [v1.1.0](https://github.com/mcci-catena/ArduinoCore-samd/releases/tag/v1.1.0) adds support for the MCCI Catena 4420 and 4470. It also adds the ability to select the target LoRaWAN region from the IDE Tools menu (assuming that you're using the [MCCI Catena arduino-lmic](https://github.com/mcci-catena/arduino-lmic) library). It also fixes the USB product ID numbers to match the official numbers assigned by MCCI release engineering (issue [#9](https://github.com/mcci-catena/ArduinoCore-samd/issues/9)).
 
 ## License and credits
 
 This core has been developed by Arduino LLC in collaboration with Atmel. The copyright notice doesn't
-include Adafruit, but we think it probably should.
+include Adafruit, but we think it probably should. Additional work was done by MCCI to incorporate better support LoRaWAN and the MCCI family of SAMD-based LoRa boards.
 
 ### LGPL License
 ```text

platform.txt

@@ -20,7 +20,7 @@
 # https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5---3rd-party-Hardware-specification
 
 name=MCCI Catena SAMD Boards
-version=1.1.0
+version=1.2.0
 
 # Compile variables
 # -----------------