pinetime/wasp-os
1
0
Fork 0
Code Activity

README: Better document how to meet the dependancies

Browse source 
Fixes: #1
Fixes: #3
This commit is contained in:
Daniel Thompson 2020-05-20 21:55:11 +01:00
parent 60bb43e87b
commit 5d2ca4a8ee
2 changed files with 45 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.rst
View file

@ -47,29 +47,59 @@ which includes a detailed `Applicaiton Writer's Guide
<https://daniel-thompson.github.io/wasp-os/appguide.html>`_ to help you <https://daniel-thompson.github.io/wasp-os/appguide.html>`_ to help you
get started coding for wasp-os as quickly as possible. get started coding for wasp-os as quickly as possible.
Building from a git clone Building from source
------------------------- --------------------
Get the code from Building wasp-os and launching the wasp-os simulator requires the
`https://github.com/daniel-thompson/wasp-os <https://github.com/daniel-thompson/wasp-os>`_ . 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 .. code-block:: sh
pip3 install --user click serial pyserial sudo apt install \
make submodules git build-essential libsdl2-2.0.0 \
make softdevice python3-click python3-numpy python3-pexpect \
make -j `nproc` BOARD=pinetime all 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
<https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
(9-2019-q4) from Arm.
.. note:: .. note::
You will need a toolchain for the Arm Cortex-M4. wasp-os is developed and
tested using the `GNU-RM toolchain
<https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
(9-2019-q4) from Arm.
There are known problems with toolchains older than gcc-7.3 due to problems There are known problems with toolchains older than gcc-7.3 due to problems
with link-time-optimization (which is enabled by default). 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
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
Finally to test out ideas and concepts on the simulator try:
.. code-block:: sh
make sim
See :ref:`Testing on the simulator` for more details on how
to use the simulator.
Installing Installing
---------- ----------

2
docs/appguide.rst
View file

@ -196,6 +196,8 @@ __ http://docs.micropython.org/en/latest/reference/constrained.html
How to run your application How to run your application
--------------------------- ---------------------------
.. _Testing on the simulator:
Testing on the simulator Testing on the simulator
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~