summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-12-04simulator: Introduce fully automatic testintDaniel Thompson
Currently the tests do little more than fire up the simulator and switch into (and out of) the built in applications. However this is useful and allows us to fully integrate as a CI job. Unfortunately the numpy warning from pysdl2 mean we have been forced to disable all warnings to prevent pytest from collecting and reporting them. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29apps: snake: Add a snake game applicationJohannes Wache
Signed-off-by: Johannes Wache <jbwa@posteo.de> [daniel@redfelineninja.org.uk: Removed some couple of unwanted merge artifacts] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29github: actions: Ensure warning free docs buildDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29apps: alarm: Add the alarm app to the libraryDaniel Thompson
Like the other library applications this is enabled in the simulator and included in the flash image but is disabled by default to conserve RAM (and to give time to new apps to mature and receive improvements). Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-29docs: Makefile: Turn sphinx warnings into errorsDaniel Thompson
Currently patches that break the documentation build are not triggering CI failure. Fix this. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-26Add wget to build dependenciesMaarten de Jong
Signed-off-by: Maarten de Jong <accounts@arteeh.com>
2020-11-26docs: contributing: Add a simple style guideDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22docs: install: Update install requirementsDaniel Thompson
Some of the new reloader features require additonal python modules. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22docs: Wordsmtithing updates after reviewDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-22apps: music: Add to application indexDaniel Thompson
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-14docs: install: Update for newer PineTime devicesDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08docs: Add an Application Library chapterDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08docs: install: Fix error message during documentation generationDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08docs: refman: Add the fibonacci clock to the reference manualDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-06docs: update building from source apt dependenciesSergio Schvezov
The softdevice make target requires unzip Signed-off-by: Sergio Schvezov <sergio.schvezov@ubuntu.com>
2020-09-16docs: install: Describe unsupported step counter in P8aDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-30docs: install: Add a troubleshooting guideDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-27docs: Update after review (and add K9)Daniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-19docs: install: Add instruction for installing modules with pipPanagiotis Vasilopoulos
Signed-off-by: Panagiotis Vasilopoulos <hello@alwayslivid.com>
2020-08-15contributing: Added a git quick fix howtoDaniel Thompson
Suggested-by: Panagiotis Vasilopoulos <hello@alwayslivid.com> Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-08-14docs: Add a contributors guideDaniel Thompson
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-07-31docs: install: Move Building from source into the install guideDaniel Thompson
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-30install: Improve formating, add links and other good stuffDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-07-29install: Initial attempt at an install guideDaniel Thompson
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-09docs: Introduce project logoDaniel Thompson
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-05-20README: Better document how to meet the dependanciesDaniel Thompson
Fixes: #1 Fixes: #3
2020-05-15README/TODO: Switch to restructured textDaniel Thompson
2020-05-15docs: Experimental workaround for readthedocs.orgDaniel Thompson
2020-05-14wasp: watch: docstrings for the watch namespaceDaniel Thompson
2020-05-14Make wasp-os namig consistantDaniel Thompson
Rename WASP to wasp-os (or Wasp-os)
2020-05-14wasp: Even more docstringsDaniel Thompson
2020-05-14wasp: draw565: docstrings for headings and __init__Daniel Thompson
2020-05-14drivers: vibrator: Finalize docstringsDaniel Thompson
2020-05-14drivers: st7789: Finalize docstringsDaniel Thompson
2020-05-14drivers: signal: Finalize docstringsDaniel Thompson
2020-05-14drivers: nrf_rtc: Finalize docstringsDaniel Thompson
2020-05-14drivers: cst816s: Finalize docstringsDaniel Thompson
2020-05-14drivers: battery: Finalize docstringsDaniel Thompson
2020-05-13docs: appguide: Describe how to hack on frozen modulesDaniel Thompson
2020-05-11docs: appguide: Switch to proper note formatDaniel Thompson
2020-05-11docs: Introduce the Application Writer's Guide.Daniel Thompson
2020-05-10docs: Document the bootloader protocolsDaniel Thompson
GPREGRET, PNVRAM and WDT protocols are all now fully documented.
2020-04-11docs: Makefile: Try to avoid nuking the .git directory...Daniel Thompson
... if there is one.
2020-04-11docs: gnu-lgpl-v3.0: Fix some broken indentation.Daniel Thompson
2020-04-11docs: Fix warnings and add a few extra apps to the docsDaniel Thompson
2020-03-22Add licensing information for all wasp-os files.Daniel Thompson
2020-03-22Rename manager.py and expose its interfaces to all applicationsDaniel Thompson
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-08docs: Increase the scope of the documentationDaniel Thompson
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-08wasp: Move the apps into their own directory.Daniel Thompson
2020-02-23docs: Add a sphinx boardDaniel Thompson
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!
generated by cgit v0.10.2 at 2026-01-10 19:43:09 (GMT)