From 5d2ca4a8ee2aec43e88a43d443ff119d103a8532 Mon Sep 17 00:00:00 2001 From: Daniel Thompson Date: Wed, 20 May 2020 21:55:11 +0100 Subject: README: Better document how to meet the dependancies Fixes: #1 Fixes: #3 diff --git a/README.rst b/README.rst index 8341569..0ecb26d 100644 --- a/README.rst +++ b/README.rst @@ -47,28 +47,58 @@ which includes a detailed `Applicaiton Writer's Guide `_ to help you get started coding for wasp-os as quickly as possible. -Building from a git clone -------------------------- +Building from source +-------------------- + +Building wasp-os and launching the wasp-os simulator requires the +following python modules: click, numpy, pexpect, PIL (or Pillow), +pyserial, pysdl2. + +On Debian Buster the requires python modules can be obtain with the +following commands: + +.. code-block:: sh + + sudo apt install \ + git build-essential libsdl2-2.0.0 \ + python3-click python3-numpy python3-pexpect \ + python3-pil python3-pip python3-serial + pip3 install --user pysdl2 + +You will need a toolchain for the Arm Cortex-M4. wasp-os is developed and +tested using the `GNU-RM toolchain +`_ +(9-2019-q4) from Arm. + +.. note:: + + There are known problems with toolchains older than gcc-7.3 due to problems + with link-time-optimization (which is enabled by default). Get the code from -`https://github.com/daniel-thompson/wasp-os `_ . +`https://github.com/daniel-thompson/wasp-os `_ : .. code-block:: sh - pip3 install --user click serial pyserial + git clone https://github.com/daniel-thompson/wasp-os + cd wasp-os make submodules make softdevice + +Build the firmware: + +.. code-block:: sh + make -j `nproc` BOARD=pinetime all -.. note:: +Finally to test out ideas and concepts on the simulator try: - You will need a toolchain for the Arm Cortex-M4. wasp-os is developed and - tested using the `GNU-RM toolchain - `_ - (9-2019-q4) from Arm. +.. code-block:: sh - There are known problems with toolchains older than gcc-7.3 due to problems - with link-time-optimization (which is enabled by default). + make sim + +See :ref:`Testing on the simulator` for more details on how +to use the simulator. Installing ---------- diff --git a/docs/appguide.rst b/docs/appguide.rst index ca69ed9..3e71b78 100644 --- a/docs/appguide.rst +++ b/docs/appguide.rst @@ -196,6 +196,8 @@ __ http://docs.micropython.org/en/latest/reference/constrained.html How to run your application --------------------------- +.. _Testing on the simulator: + Testing on the simulator ~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v0.10.2