Merge pull request #2 from microbit-foundation/release-cleanup

Prepare for V1 release on GitHub

Author: jaustin

.gitignore

@@ -0,0 +1,74 @@
+#################
+# Project files #
+#################
+.build
+projectfiles
+
+# yotta build folders
+yotta_targets
+yotta_modules
+.yotta.json
+
+# Python byte-compiled optimized files
+__pycache__/
+*.py[cod]
+
+# Node related
+package-lock.json
+node_modules
+
+############
+# OS files #
+############
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Windows Dump file
+*.stackdump
+
+# Windows Folder config file
+[Dd]esktop.ini
+
+# Windows Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows shortcuts
+*.lnk
+
+# macOS General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# macOS Thumbnails
+._*
+
+# macOS Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# macOS Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Linux temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# Linux .nfs files are created when an open file is removed but is still being accessed
+.nfs*

CONTRIBUTING

@@ -0,0 +1,11 @@
+Thanks for looking here! We'd love your help. The micro:bit project is only possible through contributions of companies and individuals around the world.
+
+This project is managed on GitHub, and the best way to contribute is to jump in and fix/file issues
+
+https://github.com/microbit-foundation/microbit-firmata
+
+The original author of the project wrote considerable notes on the possible ways to implement micro:bit radio functionality in this project, and the possibility of running the same interface over BLE UARTs. 
+
+If you're interested in working on any of these items, please file an issue and mention @jaustin
+
+

CONTRIBUTORS

@@ -0,0 +1 @@
+The original implementation was written by John Maloney, contracted by the Micro:bit Educational Foundation, and in conjunction with the micro:bit team and code.org. 

README.md

@@ -19,14 +19,14 @@ the micro:bit over a USB-serial connection.
 
 A precompiled .hex file is provided for easy firmware installation (so you don't need
 to compile it yourself) and a Javascript test suite is provided to test and demonstrate
-the system.
+the system. This precompiled hex can be found as part of the latest GitHub Release.
 
 ### Installing Firmata on your BBC micro:bit
 
 To install the Firmata firmware, plug in your BBC micro:bit, then drag and drop
-the most recent .hex file from the **precompiled** folder (e.g. **microbit-firmata-v0.9.hex**)
-onto the micro:bit's virtual USB drive. The yellow light will flash for a few seconds
-as the firmware loads. When it stops, the Firmata firmware is installed.
+the most recent .hex file from the [**GitHub Releases**](https://github.com/microbit-foundation/microbit-firmata/releases) onto the micro:bit's virtual USB drive. The yellow
+light will flash for a few seconds as the firmware loads. When it stops, the Firmata
+firmware is installed.
 
 **Note:** If you install another program on your micro:bit you'll need to re-install the
 Firmata firmware before working with Firmata again. Fortunately, that's easy and only takes
@@ -92,9 +92,6 @@ runs in Node.js. This folder also contains the micro:bit Firmata test suite.
 Besides confirming that Firmata works, the test suite is a handy source of code
 you can copy and modify to use in your own applications.
 
-The **precompiled** folder contains precompiled .hex files for the latest versions of
-the firmware.
-
 The **firmware** folder contains the C++ source code for the Firmata firmware that runs in
 the micro:bit. It's easier to use the precompiled .hex file than to compile from source.
 
@@ -103,8 +100,9 @@ Additional MarkDown files document the client API and the firmware implementatio
 ### Building the firmware from source
 
 If you just want to use Firmata, you don't need to build it yourself. The latest
-compiled version is available in the **precompiled** folder. You can install it just
-by dragging and dropping the .hex file onto the USB drive of your BBC micro:bit.
+compiled version is available **precompiled** folder or from a GitHub release. You
+can install it just by dragging and dropping the .hex file onto the USB drive of your
+BBC micro:bit.
 
 However, if you'd like to extend or improve the firmware,
 then building it will be the first step.
@@ -132,3 +130,5 @@ You can use the test suite to confirm that it works.
 ### License
 
 This software is under the MIT open source license.
+
+SPDX-License-Identifier: MIT