c53ca32561
README: Add gcc and arm-none-eabi-newlib to list of required components.
...
gcc is required for mpy-cross, and arm-none-eabi-newlib for ports using
arm-none-eabi-gcc.
2017-10-19 12:38:28 +11:00
829c329daf
README: Add explicit section on contributing.
...
To increase visibility of Contributors' Guidelines and Code Conventions
docs.
2017-10-15 10:17:24 +03:00
6e06512e0f
README: Update "Dependencies" section.
...
Given that various ports now require submodules, rewrite the section
to be more generic.
Also, add git submodule update command to other sections for easy user
start.
2017-09-11 00:33:39 +03:00
4a93801c12
all: Update Makefiles and others to build with new ports/ dir layout.
...
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-09-06 14:09:13 +10:00
02e9337494
README: Improve description of precompiled bytecode; mention mpy-cross.
2017-06-26 15:33:43 +10:00
7455e40186
README: Mention support for bytecode and frozen bytecode.
2017-06-24 17:33:47 +03:00
fb139a4ba6
README: Change Travis & Coveralls badges to not use link references.
...
Link references don't seem to work anymore.
2017-03-26 17:03:54 +11:00
fa17eabce9
README: Describe extmod/ dir.
2017-03-25 17:12:24 +03:00
c16d1c07ca
README: Add link to docs.micropython.org.
2017-03-25 17:07:57 +03:00
ddb56a0a84
README: Explicitly mention "await" support, and formatting for keywords.
2017-03-08 00:29:08 +01:00
5d0735b93a
README: "MicroPython board" is much more commonly known as PyBoard.
2016-10-21 04:40:10 +03:00
998578a2b8
README: Mention _thread module availability in select ports.
2016-10-12 19:12:20 +03:00
c528489eee
README: Remove issue-stats badges, the service is no longer available.
...
The issue-stats service is not well maintained and likely the situation
won't improve in the future. See:
https://github.com/hstove/issue_stats/issues/41
https://github.com/hstove/issue_stats/issues/46
2016-09-22 10:38:49 +10:00
282d81a40e
README: "quick build": Use "make axtls" after all.
...
"make deplibs" also builds libffi, and that requires GNU autotools. As
we use host libffi by default, skip requiring users to build it for now.
2016-05-28 21:08:09 +03:00
e66b3042d6
README: Add "make deplibs" to quick build section.
2016-05-28 20:41:39 +03:00
772c73fa16
README: Add explicit note that subdirs contain more READMEs.
2016-05-14 06:33:47 +03:00
3f3ccef829
README: Mention support "async" keyword from Python 3.5.
2016-04-29 15:44:53 +03:00
c10d303e1b
README: Promote "docs" and "tests" to "major components".
2016-04-29 00:02:31 +03:00
97f88eebb6
README: Explicitly point to required dependencies section.
2016-04-18 22:37:42 +03:00
bb293e6bcf
stmhal: Add stmhal-specific README.md with extra details for this port.
2016-03-08 12:00:38 +00:00
2c72ae5c29
stmhal: Switch from dfu-util to tools/pydfu.py for deflt deploy method.
...
tools/pydfu.py is now the recommended way of deploying a DFU file. Old
behaviour of dfu-util can be obtained by passing USE_PYDFU=0 when invoking
make.
The main README.md file has been updated to reflect this change.
2016-03-08 11:58:39 +00:00
53fec1ef48
README.md: Add link to micropython.org.
2016-02-17 23:01:49 +00:00
a9f3030371
docs: Add docs about REPL paste-mode and Control-C
2015-11-03 23:28:53 +00:00
98fb0bf68a
docs: Move instructions on generating the documentation to docs/README.md
2015-11-03 23:28:27 +00:00
1bfa6ae6e4
README: Fix typo in package name.
2015-11-04 00:54:56 +03:00
3833d3846d
README: Adjust suggested path for generated docs.
2015-10-31 01:32:48 +03:00
9d7ef05caf
README: Document how to enable/build external dependencies.
2015-10-21 02:56:42 +03:00
fccbe9aa4d
README.md: Document "Ctrl+D" shell exit.
2015-10-12 00:15:41 +01:00
0334058fa4
Rename "Micro Python" to "MicroPython" in REPL, help, readme's and misc.
2015-10-12 00:06:25 +01:00
5ab0a4a671
README: Add hint about "micropython --help".
...
Also, hint about possibility to adjust heap size.
2015-08-22 23:56:28 +03:00
65dc960e3b
unix-cpy: Remove unix-cpy. It's no longer needed.
...
unix-cpy was originally written to get semantic equivalent with CPython
without writing functional tests. When writing the initial
implementation of uPy it was a long way between lexer and functional
tests, so the half-way test was to make sure that the bytecode was
correct. The idea was that if the uPy bytecode matched CPython 1-1 then
uPy would be proper Python if the bytecodes acted correctly. And having
matching bytecode meant that it was less likely to miss some deep
subtlety in the Python semantics that would require an architectural
change later on.
But that is all history and it no longer makes sense to retain the
ability to output CPython bytecode, because:
1. It outputs CPython 3.3 compatible bytecode. CPython's bytecode
changes from version to version, and seems to have changed quite a bit
in 3.5. There's no point in changing the bytecode output to match
CPython anymore.
2. uPy and CPy do different optimisations to the bytecode which makes it
harder to match.
3. The bytecode tests are not run. They were never part of Travis and
are not run locally anymore.
4. The EMIT_CPYTHON option needs a lot of extra source code which adds
heaps of noise, especially in compile.c.
5. Now that there is an extensive test suite (which tests functionality)
there is no need to match the bytecode. Some very subtle behaviour is
tested with the test suite and passing these tests is a much better
way to stay Python-language compliant, rather than trying to match
CPy bytecode.
2015-08-17 12:51:26 +01:00
fe99ea9aab
README: Add quick information about builtin upip package manager.
...
Also, simplify dependencies info now that we no longer require GNU
readline.
2015-06-22 20:06:12 +03:00
fb4b800820
README: Mention esp8266 port.
2015-06-18 11:44:04 +03:00
0a903be7d0
README.md: Correct port names in the documentation build command.
2015-06-11 09:15:07 +02:00
cfcf47c064
docs: Add initial draft documentation for the WiPy.
...
This makes all common files "port-aware" using the .. only directive.
2015-06-10 23:37:56 +02:00
23008db6e1
README.md: Add the CC3200 port to the list of additional components.
2015-04-18 19:49:00 +02:00
c0dcf6e878
README: Add note about pic16bit port.
2015-04-03 14:16:49 +01:00
2a68c2c21b
README.md: Add issuestats badges for PRs and issues.
2015-03-03 21:53:35 +00:00
18fd7e8305
README.md: Change coveralls badge from travis-testing to master branch.
2015-03-01 15:12:00 +00:00
81e661f28b
travis: Add automated coverage testing using coveralls.
2015-03-01 14:50:09 +00:00
d155fecf9e
README.md: Update subdir descriptions.
2015-02-26 21:51:25 +02:00
2330fe08fe
README.md: Update list of supported Python types.
2015-02-24 16:40:15 +02:00
8c437f95fc
README.md: Promote project status from "early beta" to just "beta".
...
Also, reword purpose to avoid impression that uPy supports just one
microcontroller.
2015-02-24 16:31:00 +02:00
3bdb23d4d3
README: Update link to logo.
2014-11-17 00:41:54 +00:00
aec189a5ba
docs: Add optional sphinx_rtd_theme; add docs build instructions.
...
The sphinx_rtd_theme is used by ReadTheDocs to render a pretty looking
documentation. If you have this theme installed locally then your
locally-compiled docs will look exactly like the published
documentation. Otherwise it falls back to the default theme.
2014-11-15 19:01:19 +00:00
945df4e564
README: Update "unix" section with more info/details.
2014-10-11 20:45:32 +03:00
2090a98e80
Updating README.md to include the fact that the Unix build requires pkg-config to build the FFI module.
2014-10-08 17:26:03 -04:00
5aac6aa445
README: Add USB VID/PID to dfu-util command.
...
This reflects how it's done in stmhal/Makefile, via deploy.
2014-07-31 18:45:34 +01:00
aa7cf6f72f
stm: Remove long-obsolete stm/ port.
2014-05-21 20:14:27 +01:00
65114ca015
README: Add articles, and update doc for deploying firmware.
2014-05-09 12:00:23 +01:00
Damien George