aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Campora2015-06-10 23:29:56 +0200
committerDaniel Campora2015-06-10 23:37:56 +0200
commitcfcf47c0644952358e1a260db159e807872a37e6 (patch)
tree02522a025a7b803d7de0589dd743b34f3daa4634 /README.md
parentb630de1103cd07ac0656c76c7f90d92312705835 (diff)
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 04df97935..2c9396b04 100644
--- a/README.md
+++ b/README.md
@@ -121,6 +121,8 @@ preferably in a virtualenv:
In `micropython/docs`, build the docs:
- make html
+ make MICROPY_PORT=<port_name> BUILDDIR=<port_name>/build html
-You'll find the index page at `micropython/docs/build/html/index.html`.
+Where ``<port_name>`` can be ``port_unix``, ``port_pyboard``, ``port_wipy`` or ``port_esp8266``.
+
+You'll find the index page at `micropython/docs/<port_name>/build/html/index.html`.