summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-01-01 21:52:35 +0000
committerDamien George <damien.p.george@gmail.com>2014-01-01 21:52:35 +0000
commit8bbd112938636270c16d5628d1f3efea599407c3 (patch)
treec941242fe43fe6d49c7497ba0d96a98045b47f21
parentdf884fe4cc769a78eab5b2b021d7e24a88adb58b (diff)
downloadmicropython-8bbd112938636270c16d5628d1f3efea599407c3.tar.gz
micropython-8bbd112938636270c16d5628d1f3efea599407c3.zip
Update README with disclaimer for changing code; use gmake on BSD.
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index 867e907327..fc334a22ea 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,11 @@ This is the Micro Python project, which aims to put an implementation
of Python 3.x on a microcontroller. The project also includes a small
microcontroller board based around the STM32F405RG.
+WARNING: this project is in its early stages and is subject to large
+changes of the code-base, including project-wide name changes and API
+changes. The software will not start to mature until March 2014 at the
+earliest. For the moment the priority is the hardware.
+
Major components:
- py/ -- the core Python implementation, including compiler and runtime.
- unix/ -- a version of Micro Python that runs on Unix.
@@ -18,7 +23,7 @@ Additional components:
- tests/ -- test framework and test scripts.
- tools/ -- various tools.
-"make" is used to build the components.
+"make" is used to build the components, or "gmake" on BSD-based systems.
The Unix version
----------------