1 Introduction
2 ------------
3
4 Micropython is a language environment incorporating a compiler for a
5 simplified version of the Python programming language which targets a simple
6 instruction set supported by a virtual machine known as RSVP (a Really Simple
7 Virtual Processor).
8
9 The RSVP instruction set is intended to map relatively closely to instructions
10 employed by real processors, with only a few "macroinstructions" which would
11 probably be implemented as short macros or library routines in programs
12 translated to the instruction set of a real target processor.
13
14 Quick Start
15 -----------
16
17 Currently, the test.py program is the principal means of compiling and running
18 code. For example, to inspect the logical.py test program...
19
20 python -i test.py tests/logical.py -m
21
22 ...will provide a number of objects which can then be inspected, notably the
23 rm (RSVP machine) object which provides the following methods:
24
25 * show - reveals the contents of the machine's memory
26 * run - starts execution of the code in the memory
27 * step - steps through the code one instruction at a time
28 * dump - shows the machine's registers
29
30 To run a test and check the output, specify the -t option:
31
32 python test.py tests/logical.py -t
33
34 To run all tests, use the test_all.py program:
35
36 python test_all.py
37
38 Both programs support optimisations either using the -o flag immediately
39 followed (no space or separator) by a comma-separated list of options (defined
40 in the docs/optimisations.txt document) or by specifying -omax to apply all
41 possible optimisations.
42
43 Contact, Copyright and Licence Information
44 ------------------------------------------
45
46 The current Web page for micropython at the time of release is:
47
48 http://www.boddie.org.uk/python/micropython.html
49
50 Copyright and licence information can be found in the docs directory - see
51 docs/COPYING.txt and docs/gpl-3.0.txt for more information.