Commit graph

208 commits

Author SHA1 Message Date
Riku Isokoski 093a66c8f8
Simplify contribute.md (#1281) 2022-08-21 14:43:56 +03:00
Riku Isokoski e02b58bf1b
Move all images to doc. Remove old images. (#1282) 2022-08-21 14:42:53 +03:00
Riku Isokoski 93477e25cf
Docs reorganization (#1236)
* Docs reorganization

Removed broken link

* README.md relative link consistency
2022-07-21 23:02:33 +03:00
Finlay Davidson 4482078d84 Downgrade GNU Arm Toolchain to 10.3-2021.10
This is because of this bug:
https://community.arm.com/support-forums/f/compilers-and-libraries-forum/52623/gcc-11-2-arm-none-eabi-internal-compiler-error-illegal-instruction
It is causing some of the GitHub Actions builds to fail.
2022-07-08 17:18:21 +02:00
Riku Isokoski c0770cde8a
Add InfiniTime Vision document (#1196) 2022-06-29 22:31:35 +03:00
Christoph Honal 8b0559c481 Add basic hardware configuration options for P8
This enables the configuration of the LFCLK source,
as well as the target hardware board pin configuration.
2022-06-27 08:28:48 +03:00
Finlay Davidson 373289c072 Be more specific about the compiler version 2022-06-11 22:59:38 +03:00
Finlay Davidson 350bca3965 Replace more instances of old gcc ver 2022-06-11 22:59:38 +03:00
Finlay Davidson 94cd2ba563 Update arm gcc toolchain to 11.2-2022.02
Updates the buildAndProgram doc and the docker
image, which means GitHub Actions will also use
the new toolchain.
2022-06-11 22:59:38 +03:00
kieranc 7e169ee4aa
Fix typo in gettingStarted guide (#1178) 2022-06-07 21:44:40 +03:00
Seth Itow 17079fb114 doc: Fix imageFile.png path in SWD.md 2022-06-06 21:20:13 +02:00
luz paz 20ac1cd374 revert portion of previous commit 2022-06-05 09:31:23 +03:00
luz paz 03a510bd18 Fix various typos
Found via `codespell -q 3 -S ./src/libs -L ans,doubleclick,trough`
2022-06-05 09:31:23 +03:00
Jean-François Milants dd313eb419 Docker container documentation : Fix typos, 1 line per sentence, remove obsolete paragraph, remove redundant 'image' parameter in the command to build the docker image, use ${PWD} instead of $(pwd). 2022-05-26 11:35:25 +02:00
Jean-François Milants 9b216bb16f Docker container documentation : Adapt the --user documentation according to the new behavior. 2022-05-26 11:35:25 +02:00
Jean-François Milants c77f923a33 Update links to the docker image with the new account : infinitime/infinitime-build. 2022-05-26 11:35:25 +02:00
Jean-François Milants 83b3a2a469 Small modernization with --platform parameter in docker readme 2022-05-26 11:35:25 +02:00
Jean-François Milants 831f93cd92 The main build workflow for GitHub Actions now uses the infinitime-build docker image to build the firmware. This allows to avoid the duplication of the build logic in Docker and Github workflow format.
The Dockerfile has been slightly adapted (remove the USER instructions). Docker images are now published in DockerHub (jf002/infinitime-build).
2022-05-26 11:35:25 +02:00
Yehoshua Pesach Wallach 34506be06e
comment about common error "glyphs.map" in old nodejs (#1142) 2022-05-18 16:14:58 +02:00
Reinhold Gschweicher 324927f2b7 update build stop, lv_font_conv not required globally installed 2022-05-16 11:59:44 +03:00
Yehoshua Pesach Wallach d967ed7d90 fontgen: move lv_font_conv doc 2022-05-10 22:20:02 +02:00
Riku Isokoski a9b77ae0d4 Alarm: Change checkable button for a switch 2022-02-12 18:36:11 +01:00
Eli Weiss ab059b9004 Revised documentation 2021-12-30 20:57:26 +01:00
Eli Weiss 97668c775b Improved "Getting Started" readability
Clarified ambiguous references, clarified phrasing
2021-12-30 20:57:26 +01:00
Eli Weiss 90352af626 Improved documentation readability
Improved documentation readability by rephrasing confusing sentences. Added Sitronix ST7789V datasheet link to SPI-LCD-driver.md for easier reference.
2021-12-30 20:57:26 +01:00
Eli Weiss c8214bc666 Update MemoryAnalysis.md
Cleaned up MemoryAnalysis.md for greater readability
2021-12-30 20:57:26 +01:00
Eli Weiss f66fcdd3ca Improved documentation readability
Removed extra space in contribute.md and cleaned up MemoryAnalysis.md phrasing and confusing punctuation.
2021-12-30 20:57:26 +01:00
Eli Weiss 1832a6c231 Update buildAndProgram.md
Improved documentation readability.
2021-12-30 20:57:26 +01:00
JF 8ab959b4dc
Merge pull request #839 from Arsen6331/BLE-FS-Docs
Add documentation for BLE FS
2021-12-20 21:06:29 +01:00
Avamander 3eebe66d65 Updated docs and renamed functions for consistency 2021-12-04 22:03:40 +02:00
Jean-François Milants 298f0f4335 Merge branch 'restructure_includes' of https://github.com/NeroBurner/InfiniTime into NeroBurner-restructure_includes
# Conflicts:
#	doc/contribute.md
#	src/displayapp/screens/BatteryInfo.h
2021-11-28 13:53:03 +01:00
Riku Isokoski d5e8e3ca44 Split updating and about software. Remove big Contributing section from README 2021-11-28 13:42:37 +01:00
Riku Isokoski 45a90e4967 Update getting started. New pics. More information. 2021-11-28 13:42:37 +01:00
Riku Isokoski caec4a560b Replace some "we" 2021-11-28 13:42:37 +01:00
Riku Isokoski a326e22986 Add line break 2021-11-28 13:42:37 +01:00
Riku Isokoski 3375c4e187 Add missing periods 2021-11-28 13:42:37 +01:00
Riku Isokoski c12fc5e313 Improvements to Apps.md and Intro.md 2021-11-28 13:42:37 +01:00
Riku Isokoski d1583035d9 Link to companion apps 2021-11-28 13:42:37 +01:00
Riku Isokoski 5eaae4175c Fix versioning 2021-11-28 13:42:37 +01:00
Riku Isokoski e53f1bfd66 Summarize updating-softare 2021-11-28 13:42:37 +01:00
Riku Isokoski 88e55b2504 Update updating instructions 2021-11-28 13:42:37 +01:00
Riku Isokoski a0c7b48b8e Replace companionapp pages with links. Add companion apps 2021-11-28 13:42:37 +01:00
Riku Isokoski 2314c41ad6 Reorganize bootloader readme 2021-11-28 13:42:37 +01:00
Riku Isokoski 52d1906589 Separate and update coding conventions and contributing pages 2021-11-28 13:42:37 +01:00
Riku Isokoski 1d3098baa7 Update ui_guidelines 2021-11-28 13:42:37 +01:00
Riku Isokoski c3c5ab3473 Reorganization 2021-11-28 13:42:37 +01:00
Riku Isokoski cf9332f0e5 Crop and shrink photos 2021-11-28 13:42:37 +01:00
Riku Isokoski 4aaf3d06bc Documentation cleanup and reorganization 2021-11-28 13:42:37 +01:00
Arsen6331 47f73269bb
Add BLE FS docs link to BLE docs 2021-11-24 22:22:04 +00:00
Arsen6331 7322f3286b
Add documentation for BLE FS 2021-11-22 00:35:50 +00:00
Reinhold Gschweicher 3a41bff9ea docs: add non-relative includes to coding standard 2021-11-15 22:02:49 +01:00
mabuch a631fa3518 fix Motion Service UUID in doc and code comments 2021-11-15 20:41:32 +01:00
JF d00687ca41
Merge pull request #784 from SteveAmor/patch-2
Correctly Define DFU
2021-10-30 17:23:27 +02:00
Jean-François Milants e051504dea Add doc : how to generate files needed by the factory. 2021-10-28 20:56:17 +02:00
Steveis 0fc081fe03
Correctly define DFU 2021-10-26 16:57:20 +01:00
JF 82ca526ec2
Merge pull request #754 from InfiniTimeOrg/add-motion-service
Add motion service
2021-10-24 20:06:52 +02:00
Riku Isokoski f56bd4ce9d Update coding style 2021-10-22 12:42:06 +03:00
JF 9363d4467f
Merge pull request #657 from NeroBurner/patch-1
Add python packages click and cryptography to build instructions
2021-10-22 10:02:56 +02:00
JF 17c5a03938
Merge pull request #751 from carlosperate/docker-docs
Docs: Clarify Docker image needs to be built 1st, fix URL and typos.
2021-10-20 21:35:28 +02:00
JF d025fc7c2c
Merge pull request #753 from Arsen6331/improve-ble-docs
Improve BLE documentation
2021-10-20 21:22:50 +02:00
Jean-François Milants b3a8228899 Add mention to Call characteristic (which was missing in the doc) and change the UUID of the new Motion service from 00020000-* to 00030000-*. 2021-10-20 20:52:04 +02:00
Stephanie 02d52d94d5 Added missing semicolon 2021-10-18 12:18:35 -04:00
stephanie-eng b0c4ade926
Fixed Apps tutorial to compile properly
Changed case in minimal example to properly reference Pinetime namespace
2021-10-18 00:35:47 -04:00
Jean-François Milants 31badd2eb3 Add doc about the new motion service. 2021-10-17 08:34:24 +02:00
Arsen Musayelyan 95618dd238 Fix error in music status docs 2021-10-16 21:01:12 -07:00
Arsen Musayelyan 75339323d2 Fix grammar mistakes 2021-10-16 20:52:25 -07:00
Arsen Musayelyan 2e7d4763dc Add docs from infinitime Go library's repo and fix typos and grammar 2021-10-16 20:45:08 -07:00
carlosperate ea1bc81925 Docs: Clarify Docker image needs to be built 1st, fix URL and typos. 2021-10-16 23:10:36 +01:00
mabuch 1d76d9170e Replaced "JF002" in github URLs with "InfiniTimeOrg" 2021-10-15 18:03:10 +02:00
JF 69ef5bfc8d
Merge pull request #722 from clemensvonmolo/code-structure-doc
Add docs for app creation and code structure
2021-10-15 17:42:55 +02:00
NeroBurner 55ff9b0c81 Add python packages click and cryptography to build instructions
The script `tools/mcuboot/imgtool/main.py` imports the python packages
`click` and `cryptography` to create the target `pinetime-mcuboot-app`.
Add it tothe build instructions, as it was not installed on my system.

6f9f0e8b0e/tools/mcuboot/imgtool/main.py (L19)
6f9f0e8b0e/tools/mcuboot/imgtool/keys/__init__.py (L19)

Also add the commands to install the python requirements into a python
venv virtual environment.
2021-10-11 21:46:06 +02:00
JF 5689898a5a
Merge pull request #730 from coxtor/patch-1
Add configuration instructions for Ubuntu devcontainers
2021-10-09 19:59:29 +02:00
JF 0ca018b309
Merge pull request #522 from jonvmey/fix-nav-uuid-docs
Fix Navigation Service UUID docs
2021-10-09 19:58:24 +02:00
coxtor 516f9de3e4
Add configuration instructions for Ubuntu devcontainers 2021-10-08 20:05:39 +02:00
Clemens von Molo c3cc83ae17 More reasonable line lengths in Apps.md and Intro.md 2021-10-08 14:59:45 +02:00
Clemens von Molo 884c89c61c minor corrections and notice about ui guidelines in docs 2021-10-06 18:29:52 +02:00
Clemens von Molo f1aae6af49 multiple improvements to code docs 2021-10-06 14:30:16 +02:00
Clemens von Molo b2141a9050 advise against unecessary additional tasks in docs 2021-10-05 18:55:02 +02:00
Clemens von Molo aa83fa2dcf Add docs for app creation and code structure 2021-10-05 15:19:44 +02:00
Avamander 6475330048
Removed an unnecessary space and some punctuation
Closes https://github.com/InfiniTimeOrg/InfiniTime/pull/233
2021-10-03 17:26:04 +03:00
JF002 b0bdd2be1c
Merge pull request #549 from hubmartin/pinmap
Put all duplicated GPIO pin definitions to a single file
2021-09-13 20:05:43 +02:00
Tim Gates 84a93b5441
docs: Fix a few typos (#606)
* docs: Fix a few typos

There are small typos in:
- doc/versioning.md
- src/components/ble/NimbleController.cpp
- src/libs/mynewt-nimble/CODING_STANDARDS.md
- src/libs/mynewt-nimble/docs/btshell/btshell_GAP.rst
- src/systemtask/SystemTask.cpp

Fixes:
- Should read `milliseconds` rather than `miliseconds`.
- Should read `unnecessary` rather than `uncesseray`.
- Should read `target` rather than `tharget`.
- Should read `project` rather than `projct`.
- Should read `preferred` rather than `prefered`.
- Should read `functioning` rather than `functionning`.
- Should read `forever` rather than `forver`.
- Should read `existing` rather than `exisiting`.
2021-09-13 20:02:53 +02:00
hubmartin e614af1c4a Add WATCH_COLMI_P8 option to cmake & docs 2021-09-13 11:41:51 +02:00
JF002 1235c697c4
Merge pull request #551 from hubmartin/patch-3
Add FW validation note after DFU flash
2021-09-12 17:58:11 +02:00
JF002 53d641736f
Merge pull request #550 from hubmartin/patch-2
Add link to WebBLEWatch to sync time
2021-09-12 17:57:36 +02:00
Riku Isokoski fc6458a35c Add image with example layouts 2021-08-15 11:19:47 +02:00
Riku Isokoski e0d01411d7 Ui update 2021-08-15 11:19:47 +02:00
Riku Isokoski f0e9d13329
Update contribute.md (#475)
* Update contribute.md
* Add newlines and remove spaces
* Replace CONTRIBUTING.md with doc/contribute.md
2021-08-14 20:58:38 +02:00
JF002 643077341b
Merge pull request #505 from geekbozu/devcon
VSCode Devcontainer
2021-08-10 16:54:13 +02:00
Tim Keller 7f2ee62aed Typos for days 2021-08-07 18:19:11 +00:00
Tim Keller e9248b225e Updated documentation 2021-08-07 18:19:11 +00:00
Martin Hub 2992f4afd2
Add FW validation note after DFU flash 2021-08-03 17:56:02 +02:00
Martin Hub f244c960d3
Update ota-gadgetbridge-nrfconnect.md 2021-08-03 17:41:34 +02:00
Grant 6222b7c223
Correct spelling issue in documentation (#509)
* Correct spelling issue
2021-07-25 17:58:55 +02:00
Riku Isokoski 7a6ceadb24
Update documentation (#467)
* Fix and update documentation
* Add newlines
2021-07-25 17:50:55 +02:00
Jonathan Vander Mey 54ccd2cc07 Update Navigation UUID documentation
Fixed mismatch between the service and characteristic IDs in the
navigation service comments and documentation. They had old values not
reflecting the current code and changes in doc/ble.md
2021-07-24 11:07:06 -04:00
wilsonjwco 7fee2c2589
Update buildAndProgram.md (#477)
Corrected typo in example usage of cmake BUILD_DFU option. Changed from -BUILD_DFU=1 to -DBUILD_DFU=1
2021-07-11 19:47:24 +02:00
Pekka d4f4ed014c
Update buildWithDocker.md (#416)
Added a link to instructions for cloning the repo. The purpose was mainly to remind of the git submodule update.
2021-06-12 11:16:54 +02:00
Roxxor91 44d7c6d00f
Update Amazfish.md (#386)
Add Navigation feature.
2021-06-12 11:15:39 +02:00
Itai Nelken 2c7ad783fc
Improvements to /doc/filesInReleaseNotes.md (#357)
* Update filesInReleaseNotes.md
2021-06-12 11:06:46 +02:00