Commit graph

182 commits

Author SHA1 Message Date
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
Joel Bradshaw 8fb543f4c3
Add note about getting GadgetBridge from F-Droid (#358)
* Add note about getting GadgetBridge from F-Droid

Hopefully this is useful and will save folks some frustration

* Add note that GadgetBridge should be downloaded via F-Droid

There's an "unofficial" version on the Play Store that is outdated and doesn't have PineTime support

* Fix typo

* Add starting version, reword a bit

Initial support version is a little fuzzy, 0.47 states it's "not yet usable" but changelog doesn't specify when we've crossed the "usable" threshold.
2021-06-12 11:05:57 +02:00
JF002 346d20db52
Rewrite MemoryAnalysis.md with up to date information. (#411)
Rewrite MemoryAnalysis.md with up to date information.
2021-06-12 11:02:54 +02:00
JF002 4e95e4b538
Merge pull request #345 from Itai-Nelken/patch-1
fix a formatting issue and 2 typos in gettingStarted-1.0.md
2021-05-15 09:59:55 +02:00
CoderThomasB 7571d477f9 Fixed typos in the doc/contribute.md using google docs’s spelling check system 2021-05-14 19:28:54 +12:00
Itai Nelken e05ac21039
Update gettingStarted-1.0.md 2021-05-13 14:52:23 +03:00
Itai Nelken 117da314bc
Update gettingStarted-1.0.md 2021-05-13 14:48:11 +03:00
Jean-François Milants c82dee2def Add missing pictures. 2021-05-13 13:21:18 +02:00
Jean-François Milants 88e3790fbf Merge branch 'develop' of github.com:JF002/Pinetime into develop 2021-05-13 13:20:19 +02:00
Jean-François Milants afd5ac0d4a Add quick user guide for InfiniTime 1.0 2021-05-13 13:19:48 +02:00
JF002 9e1ce2d423
Merge pull request #266 from Caton101/patch-1
Add Python modules to build instructions
2021-05-09 11:21:05 +02:00
JF002 242620b73e Improve doc/contribute.md : add more info and TL;DR 2021-05-02 14:11:22 +02:00
JF002 bc9a782f41 Improve contributes.md : give more detailed guideline on how to create a good pull-request 2021-05-02 14:08:09 +02:00
MysteriousLog6 cf4c13c282
Fix spelling 2021-04-18 17:30:36 +05:30
Cameron Himes 0cbbd1dfc0
Add Python modules to build instructions
I had issues building InfiniTime for the first time because the instructions never mentioned needing these Python modules. Including them in the build documentation will help people not be confused like I was.

I recommend adding all needed modules to this list. I only added the ones I knew I was missing.
2021-04-13 21:40:42 -04:00
Jean-François Milants adefa1e660 Update buildAndProgram.md with info about Debug/Release builds. 2021-03-21 17:12:19 +01:00
JF002 91ddc666e3
Merge pull request #235 from MFAshby/doc_correction
Small correction to git URL in documentation files
2021-03-20 17:54:07 +01:00
Martin Ashby bca7ba4eed
Small correction to git URL in documentation files 2021-03-15 23:13:46 +00:00
Jean-François Milants 9f67e6f652 Merge branch 'develop' into recovery-firmware
# Conflicts:
#	src/CMakeLists.txt
#	src/displayapp/DisplayApp.h
#	src/systemtask/SystemTask.cpp
#	src/systemtask/SystemTask.h
2021-03-07 08:44:14 +01:00
Jean-François Milants c18f4e5811 Update doc : init git submodule before build. 2021-02-23 22:37:21 +01:00
Jean-François Milants 740b3d7b58 Add new cmake option to disable the generation of DFU file (which needs adafruit-nrfutil on the build machine) : BUILD_DFU (disabled by default, enabled in docker build). 2021-02-01 21:07:53 +01:00
JF002 7e27bc8733
Merge pull request #173 from michaelPotter/patch-1
Fix config file discrepancy
2021-01-20 20:43:42 +00:00
Jean-François Milants 522a1eb0be Merge branch piggz/nav into develop:
- fix conflict
 - add a icon for the navigation app.
2021-01-20 21:34:09 +01:00
Jean-François Milants 54d437adb8 Add guideline to chose the UUID of custom BLE services in docs. 2021-01-19 21:25:57 +01:00
Michael Potter c78291de65
Fix config file discrepancy
Fixes a discrepancy with config file naming. The config files it tells you to create end in ocd, but the example flash command uses a filename ending in cfg
2021-01-19 11:07:47 -08:00
Joe Eaves 60ef9b54fb Integrate improvements from #137
Also fixed a bug with empty quoted strings
2020-12-21 03:10:42 +00:00
Joe Eaves a7df0a0279 Unify the Dockerfiles by fleshing out build.sh
Script is written to handle it's own dependencies so it can be used within Docker or on the host system
2020-12-21 01:42:41 +00:00