circuitpython/windows/README.md

75 lines
2.3 KiB
Markdown
Raw Normal View History

This is the experimental, community-supported Windows port of MicroPython.
It is based on Unix port, and expected to remain so.
The port requires additional testing, debugging, and patches. Please
consider to contribute.
2017-04-29 17:37:05 -04:00
Building on Debian/Ubuntu Linux system
---------------------------------------
2017-04-29 17:37:05 -04:00
sudo apt-get install gcc-mingw-w64
make CROSS_COMPILE=i686-w64-mingw32-
If for some reason the mingw-w64 crosscompiler is not available, you can try
mingw32 instead, but it comes with a really old gcc which may produce some
spurious errors (you may need to disable -Werror):
2017-04-29 17:37:05 -04:00
sudo apt-get install mingw32 mingw32-binutils mingw32-runtime
make CROSS_COMPILE=i586-mingw32msvc-
Building under Cygwin
---------------------
Install following packages using cygwin's setup.exe:
2017-04-29 17:37:05 -04:00
* mingw64-i686-gcc-core
* mingw64-x86_64-gcc-core
* make
Build using:
2017-04-29 17:37:05 -04:00
make CROSS_COMPILE=i686-w64-mingw32-
2017-04-29 17:37:05 -04:00
Or for 64bit:
2017-04-29 17:37:05 -04:00
make CROSS_COMPILE=x86_64-w64-mingw32-
2017-04-29 17:37:05 -04:00
Building using MS Visual Studio 2013 (or higher)
------------------------------------------------
In the IDE, open `micropython.vcxproj` and build.
To build from the command line:
2017-04-29 17:37:05 -04:00
msbuild micropython.vcxproj
__Stack usage__
The msvc compiler is quite stack-hungry which might result in a "maximum recursion depth exceeded"
RuntimeError for code with lots of nested function calls.
There are several ways to deal with this:
- increase the threshold used for detection by altering the argument to `mp_stack_set_limit` in `unix/main.c`
- disable detection all together by setting `MICROPY_STACK_CHECK` to "0" in `windows/mpconfigport.h`
- disable the /GL compiler flag by setting `WholeProgramOptimization` to "false"
See [issue 2927](https://github.com/micropython/micropython/issues/2927) for more information.
2017-04-29 17:37:05 -04:00
Running on Linux using Wine
---------------------------
The default build (MICROPY_USE_READLINE=1) uses extended Windows console
functions and thus should be ran using the `wineconsole` tool. Depending
on the Wine build configuration, you may also want to select the curses
backend which has the look&feel of a standard Unix console:
wineconsole --backend=curses ./micropython.exe
2017-04-29 17:37:05 -04:00
For more info, see https://www.winehq.org/docs/wineusr-guide/cui-programs .
If built without line editing and history capabilities
2016-07-22 14:24:26 -04:00
(MICROPY_USE_READLINE=0), the resulting binary can be run using the standard
2017-04-29 17:37:05 -04:00
`wine` tool.