aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2020-11-30README: Update badges for new GitHub Actions workflows.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2020-05-11README: Change --help option to -h to match micropython executable.Hannah Suarez/hcs0
The behaviour was changed in 83439e38fc025bda79eec0096b8cc60379757206
2020-04-23README: Fix small typo, dfeault -> default.Krsna Mahapatra
2020-04-22README: Update Travis CI links to point to travis-ci.com.Damien George
MicroPython now build at the .com rather than the .org.
2019-10-15ports: Add new make target "submodules" which inits required modules.Damien George
2019-06-03mpy-cross: Do not automatically build mpy-cross, rather do it manually.Damien George
Building mpy-cross automatically leads to some issues with the build process and slows it down. Instead, require it to be built manually.
2019-02-12py/mkenv.mk: Change default PYTHON variable from "python" to "python3".Damien George
This change makes it so that python3 is required by default to build MicroPython. Python 2 can be used by specifying make PYTHON=python2. This comes about due to a recent-ish change to PEP 394 that makes the python command more optional than before (even with Python 2 installed); see https://github.com/python/peps/commit/cd59ec03c8ff1e75089d5872520cd0706774b35b#diff-1d22f7bd72cbc900670f058b1107d426 Since the command python is no longer required to be provided by a distribution we need to use either python2 or python3 as commands. And python3 seems the obvious choice.
2018-11-26README: Remove text about selecting different ports in the docs.Damien George
2018-11-15README: Remove references to "make axtls", it's no longer needed.Damien George
Since 0be2ea50e98f9d742b9611d0289853a11d9e7f53 axtls is automatically built as part of the usual "make" build process.
2018-07-18README: Update list of ports to include esp32 and nrf.Damien George
2017-10-19README: Add gcc and arm-none-eabi-newlib to list of required components.Damien George
gcc is required for mpy-cross, and arm-none-eabi-newlib for ports using arm-none-eabi-gcc.
2017-10-15README: Add explicit section on contributing.Paul Sokolovsky
To increase visibility of Contributors' Guidelines and Code Conventions docs.
2017-09-11README: Update "Dependencies" section.Paul Sokolovsky
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-06all: Update Makefiles and others to build with new ports/ dir layout.Damien George
Also renames "stmhal" to "stm32" in documentation and everywhere else.
2017-06-26README: Improve description of precompiled bytecode; mention mpy-cross.Damien George
2017-06-24README: Mention support for bytecode and frozen bytecode.Paul Sokolovsky
2017-03-26README: Change Travis & Coveralls badges to not use link references.Damien George
Link references don't seem to work anymore.
2017-03-25README: Describe extmod/ dir.Paul Sokolovsky
2017-03-25README: Add link to docs.micropython.org.Paul Sokolovsky
2017-03-08README: Explicitly mention "await" support, and formatting for keywords.Paul Sokolovsky
2016-10-21README: "MicroPython board" is much more commonly known as PyBoard.Paul Sokolovsky
2016-10-12README: Mention _thread module availability in select ports.Paul Sokolovsky
2016-09-22README: Remove issue-stats badges, the service is no longer available.Damien George
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-05-28README: "quick build": Use "make axtls" after all.Paul Sokolovsky
"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-28README: Add "make deplibs" to quick build section.Paul Sokolovsky
2016-05-14README: Add explicit note that subdirs contain more READMEs.Paul Sokolovsky
2016-04-29README: Mention support "async" keyword from Python 3.5.Paul Sokolovsky
2016-04-29README: Promote "docs" and "tests" to "major components".Paul Sokolovsky
2016-04-18README: Explicitly point to required dependencies section.Paul Sokolovsky
2016-03-08stmhal: Add stmhal-specific README.md with extra details for this port.Damien George
2016-03-08stmhal: Switch from dfu-util to tools/pydfu.py for deflt deploy method.Damien George
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-02-17README.md: Add link to micropython.org.Damien George
2015-11-03docs: Add docs about REPL paste-mode and Control-CDave Hylands
2015-11-03docs: Move instructions on generating the documentation to docs/README.mdDave Hylands
2015-11-04README: Fix typo in package name.Mike Bryant
2015-10-31README: Adjust suggested path for generated docs.Paul Sokolovsky
2015-10-21README: Document how to enable/build external dependencies.Paul Sokolovsky
2015-10-12README.md: Document "Ctrl+D" shell exit.nyov
2015-10-12Rename "Micro Python" to "MicroPython" in REPL, help, readme's and misc.Damien George
2015-08-22README: Add hint about "micropython --help".Paul Sokolovsky
Also, hint about possibility to adjust heap size.
2015-08-17unix-cpy: Remove unix-cpy. It's no longer needed.Damien George
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-06-22README: Add quick information about builtin upip package manager.Paul Sokolovsky
Also, simplify dependencies info now that we no longer require GNU readline.
2015-06-18README: Mention esp8266 port.Paul Sokolovsky
2015-06-11README.md: Correct port names in the documentation build command.Daniel Campora
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2015-04-18README.md: Add the CC3200 port to the list of additional components.Daniel Campora
2015-04-03README: Add note about pic16bit port.Damien George
2015-03-03README.md: Add issuestats badges for PRs and issues.Damien George
2015-03-01README.md: Change coveralls badge from travis-testing to master branch.Damien George
2015-03-01travis: Add automated coverage testing using coveralls.Damien George
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-31 11:48:46 +0000