diff options
| author | Shuhao Wu <shuhao@shuhaowu.com> | 2021-02-02 23:21:18 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2021-02-20 08:44:22 (GMT) |
| commit | 268f8c06e9058338fe7a56051757efb3ddc19e33 (patch) | |
| tree | fbc5dcfea52b62a4f3841a1cb66978b6cc5da33a /docs | |
| parent | 090ed8489ba830879a8dfa094a05fc178020fa4f (diff) | |
Added Docker setup to build wasp-os.
This should make it a bit easier for people to contribute. Also fixed
the documentations on how to setup on Debian, as certain recommended
packages don't exist.
Signed-off-by: Shuhao Wu <shuhao@shuhaowu.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/install.rst b/docs/install.rst index 99fafb1..f0501ed 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -9,6 +9,9 @@ Installation Guide Building wasp-os from source ---------------------------- +Install prerequisites +~~~~~~~~~~~~~~~~~~~~~ + Building wasp-os and launching the wasp-os simulator requires Python 3.6 (or later) and the following python modules: click, numpy, pexpect, PIL (or Pillow), pydbus, pygobject, pyserial, pysdl2. @@ -50,6 +53,22 @@ tested using the `GNU-RM toolchain link time optimization is enabled during the MicroPython build (LTO is enabled by default). +Install prerequisites via docker +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To build via docker, simply invoke `tool/docker/shell` from the root directory +after having docker installed. This will build the docker image and also drop +you into a shell with wasp os's source code shared into the container at +``/home/user/wasp-os``. All ``make`` commands should be usable from this shell, +including ``make sim`` and ``make check``. Some commands that interact with +bluetooth such as ``wasptool`` may not work, for now. + +.. note:: + + If you want to use the Docker-based setup, it is assumed that you're using + and x86 machine on Linux, running Xorg. Other setup may require some + patching for now. + Fetch the code from `https://github.com/daniel-thompson/wasp-os <https://github.com/daniel-thompson/wasp-os>`_ and download the prerequisites: @@ -69,12 +88,16 @@ list below: make -j `nproc` BOARD=k9 all make -j `nproc` BOARD=p8 all +The output of these will be stored in ``build-${BOARD}/``. + To rebuild the documentation: .. code-block:: sh make docs +The docs will be browsable in ``docs/build/html`` as per Sphinx standards. + Device Support -------------- |