Revision 9:88f582853243, committed 2016-04-27

Comitter:

Colin Hogben

Date:

Wed Apr 27 21:34:50 2016 +0100

Parent:

8:6c5fa976a1e3

Child:

10:33521d742af1

Commit message:

Add README.md

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Wed Apr 27 21:34:50 2016 +0100
@@ -0,0 +1,61 @@
+This a port of [MicroPython](http://micropython.org) to the mbed Classic
+platform.
+
+This provides an interpreter running on the board's USB serial
+connection.
+
+Getting Started
+---------------
+
+Import the micropython-repl program into your IDE workspace on
+developer.mbed.org.
+Compile and download to your board.
+Connect to the USB serial port in your usual manner.
+You should get a startup message similar to the following:
+```
+  MicroPython v1.7-155-gdddcdd8 on 2016-04-23; K64F with ARM
+  Type "help()" for more information.
+  >>>
+```
+Then you can start using micropython.  For example:
+```
+  >>> from mbed import DigitalOut
+  >>> from pins import LED1
+  >>> led = DigitalOut(LED1)
+  >>> led.write(1)
+```
+
+Requirements
+------------
+
+You need approximately 100K of flash memory, so this will be no good
+for boards with smaller amounts of storage.
+
+Caveats
+-------
+
+- This can be considered an alpha release of the port; things may not
+  work; APIs may change in later releases.  It is NOT an official part
+  part the micropython project, so if anything doesn't work, blame me.
+  If it does work, most of the credit is due to micropython.
+
+- Only a few of the mbed classes are available in micropython so far,
+  and not all methods of those that are.
+
+- Only a few boards have their full range of pin names available; for
+  others, only a few standard ones (USBTX, USBRX, LED1) are
+  implemented.
+
+- The garbage collector is not yet implemented.  The interpreter will
+  gradually consume memory and then fail.
+
+- Exceptions from the mbed classes are not yet handled.
+
+- Asynchronous processing (e.g. events on inputs) is not supported.
+
+Credits
+-------
+
+- Damien P. George and other contributors who created micropython.
+
+- Colin Hogben, author of this port.

--- a/Test1.md	Wed Apr 27 19:58:16 2016 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,3 +0,0 @@
-Markdown test
-=============
-

--- a/Test2.rst	Wed Apr 27 19:58:16 2016 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +0,0 @@
-ReStructured text test
-======================