Skip to content

Commit 9fbe498

Browse files
committed
README.md: Add build instructions to README.
1 parent fe8917b commit 9fbe498

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,33 @@ of Unicorn, and allows the virtual microcontroller to run in the browser. This
99
then gives a full MicroPython port running simulated-bare-metal in a web browser.
1010

1111
For a running demo please visit https://micropython.org/unicorn
12+
13+
Build Instructions
14+
------------------
15+
16+
```
17+
$ git submodule update --init
18+
```
19+
20+
Firmware binaries can be customized in the unicorn directory.
21+
22+
```
23+
$ cd unicorn
24+
$ make CONFIG=pyboard
25+
```
26+
27+
The web page may be built using
28+
29+
```
30+
$ cd www-emu
31+
$ make
32+
```
33+
34+
In order to build without using gzip (For example when testing with `$ python -m http.server`)
35+
36+
```
37+
$ cd www-emu
38+
$ make nogzip
39+
```
40+
41+
There is a critical bug in unicorn-engine which is addressed [here](https://github.com/unicorn-engine/unicorn/pull/880). In order for full functionality apply the patch to a unicorn submodule within a unicorn.js repository and build normally.

0 commit comments

Comments
 (0)