diff options
| author | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-07-31 15:47:08 (GMT) |
|---|---|---|
| committer | Daniel Thompson <daniel@redfelineninja.org.uk> | 2020-07-31 15:47:08 (GMT) |
| commit | 66e8d3e58a506fadf1679e398e9b28db97cabe59 (patch) | |
| tree | 4523d7dbd46553f72232011ebb7afc3fa8685fb5 /README.rst | |
| parent | 70c1fb25cabbebe7870a7e3e825a571b9c15b201 (diff) | |
docs: install: Move Building from source into the install guide
Direct links to the install guide mean some people are reading the docs
but never see the main docs index and, as a result, don't find the
instructions on how to build from source. Let's fix that!
Fixes: #49
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 56 |
1 files changed, 1 insertions, 55 deletions
@@ -61,60 +61,6 @@ which includes a detailed `Applicaiton Writer's Guide <https://wasp-os.readthedocs.io/en/latest/appguide.html>`_ to help you get started coding for wasp-os as quickly as possible. -Building from source --------------------- - -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), pyserial, pysdl2. - -On Debian Buster the required python modules can be obtained using 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 also 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:: - - There are known problems with toolchains older than gcc-7.3 when - link time optimization is enabled during the MicroPython build - (and LTO 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. - Getting Started --------------- @@ -126,7 +72,7 @@ devices: The `Installation Guide <https://wasp-os.readthedocs.io/en/latest/install.html>`_ -contains detailed instructions on how to install wasp-os. +contains detailed instructions on how to build and install wasp-os. At the end of the install process your watch will show the time (03:00) together with a date and battery meter. When the watch goes into power |
