Daniel Thompson
748e5fe65a
docs: Wordsmtithing updates after review
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 09:25:24 +00:00
Daniel Thompson
6f0238415f
apps: music: Add to application index
...
Additionally we rename the screenshot to conform to the naming
convention (app.NAME + 'App.png') used for simulator screenshots.
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22 09:22:50 +00:00
Daniel Thompson
aeda73ad90
docs: install: Update for newer PineTime devices
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-14 20:07:42 +00:00
Daniel Thompson
06f1ed36b0
docs: Add an Application Library chapter
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 14:28:38 +00:00
Daniel Thompson
7015dc0023
docs: install: Fix error message during documentation generation
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 12:42:17 +00:00
Daniel Thompson
7ebc361e58
docs: refman: Add the fibonacci clock to the reference manual
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 12:41:58 +00:00
Sergio Schvezov
3423039d35
docs: update building from source apt dependencies
...
The softdevice make target requires unzip
Signed-off-by: Sergio Schvezov <sergio.schvezov@ubuntu.com>
2020-11-06 22:18:05 +00:00
Daniel Thompson
6890a52502
docs: install: Describe unsupported step counter in P8a
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-09-16 21:59:47 +01:00
Daniel Thompson
fa1515487d
docs: install: Add a troubleshooting guide
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-30 09:10:08 +01:00
Daniel Thompson
6ae968a017
docs: Update after review (and add K9)
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-27 17:11:21 +01:00
Panagiotis Vasilopoulos
5aa07e13a5
docs: install: Add instruction for installing modules with pip
...
Signed-off-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
2020-08-19 20:14:26 +01:00
Daniel Thompson
8ceda3451d
contributing: Added a git quick fix howto
...
Suggested-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-15 08:34:35 +01:00
Daniel Thompson
7d0fc8100a
docs: Add a contributors guide
...
Mostly this is adopting policies (both DCO and Contributor Covenent)
that are commonly used by other projects...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-14 20:36:01 +01:00
Daniel Thompson
66e8d3e58a
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>
2020-07-31 16:47:08 +01:00
Daniel Thompson
9c9a508580
install: Improve formating, add links and other good stuff
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-30 22:41:39 +01:00
Daniel Thompson
c3d9e3a0a2
install: Initial attempt at an install guide
...
More work needed... but a step up from the current text in the README.
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-29 22:19:52 +01:00
Daniel Thompson
c87bcd8693
docs: Introduce project logo
...
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-09 22:28:43 +01:00
Daniel Thompson
5d2ca4a8ee
README: Better document how to meet the dependancies
...
Fixes : #1
Fixes : #3
2020-05-20 21:55:11 +01:00
Daniel Thompson
56b39d6404
README/TODO: Switch to restructured text
2020-05-15 19:55:18 +01:00
Daniel Thompson
6989eaf6a6
docs: Experimental workaround for readthedocs.org
2020-05-15 12:14:28 +01:00
Daniel Thompson
e391480b50
wasp: watch: docstrings for the watch namespace
2020-05-14 23:22:57 +01:00
Daniel Thompson
d11e6eb4a1
Make wasp-os namig consistant
...
Rename WASP to wasp-os (or Wasp-os)
2020-05-14 22:41:05 +01:00
Daniel Thompson
b8efcd3053
wasp: Even more docstrings
2020-05-14 22:29:35 +01:00
Daniel Thompson
f07fb6d22a
wasp: draw565: docstrings for headings and __init__
2020-05-14 21:44:05 +01:00
Daniel Thompson
42fe7bf352
drivers: vibrator: Finalize docstrings
2020-05-14 21:42:16 +01:00
Daniel Thompson
95f1788347
drivers: st7789: Finalize docstrings
2020-05-14 21:41:02 +01:00
Daniel Thompson
9274d8cc2d
drivers: signal: Finalize docstrings
2020-05-14 21:39:14 +01:00
Daniel Thompson
880083977c
drivers: nrf_rtc: Finalize docstrings
2020-05-14 21:36:33 +01:00
Daniel Thompson
d5c629a9ac
drivers: cst816s: Finalize docstrings
2020-05-14 21:36:09 +01:00
Daniel Thompson
85079c149b
drivers: battery: Finalize docstrings
2020-05-14 21:32:01 +01:00
Daniel Thompson
4af873c9e3
docs: appguide: Describe how to hack on frozen modules
2020-05-13 22:11:31 +01:00
Daniel Thompson
15d5d70bbd
docs: appguide: Switch to proper note format
2020-05-11 23:03:15 +01:00
Daniel Thompson
a2fd52ef2b
docs: Introduce the Application Writer's Guide.
2020-05-11 21:44:30 +01:00
Daniel Thompson
bb8e95cdd4
docs: Document the bootloader protocols
...
GPREGRET, PNVRAM and WDT protocols are all now fully documented.
2020-05-10 10:43:02 +01:00
Daniel Thompson
7ef145cdc5
docs: Makefile: Try to avoid nuking the .git directory...
...
... if there is one.
2020-04-11 20:49:52 +01:00
Daniel Thompson
e165f13a9e
docs: gnu-lgpl-v3.0: Fix some broken indentation.
2020-04-11 20:49:27 +01:00
Daniel Thompson
683c3497e0
docs: Fix warnings and add a few extra apps to the docs
2020-04-11 20:26:12 +01:00
Daniel Thompson
b9fe31241c
Add licensing information for all wasp-os files.
2020-03-22 15:40:18 +00:00
Daniel Thompson
f8bd1a7461
Rename manager.py and expose its interfaces to all applications
...
This is a big change that break compatiblity with existing applications
*and* with existing installed versions of main.py.
When upgrading it is import to update main.py:
./tools/wasptool --upload wasp/main.py
2020-03-22 12:37:19 +00:00
Daniel Thompson
d2058fb87f
docs: Increase the scope of the documentation
...
We now generate documentation for everything included in the PineTime
manifest (although, at this stage, not everything in the manifest has
all the required docstrings).
2020-03-08 17:40:27 +00:00
Daniel Thompson
799a66c9b9
wasp: Move the apps into their own directory.
2020-03-08 17:39:39 +00:00
Daniel Thompson
3ba356f6c4
docs: Add a sphinx board
...
The simulator board does rather too much when we import watch.py. This
change means we don't need SDL just to generate the documentation!
2020-02-23 20:16:23 +00:00
Daniel Thompson
27e35527ff
docs: Use sphinx to gather together all the wasp docs
2020-02-22 21:17:30 +00:00