Commit graph

159 commits

Author SHA1 Message Date
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
Peter Feerick aa45f25174 Missed username for some Docker Hub commands 2020-12-15 20:17:24 +10:00
Peter Feerick 72960ef880 Minor changes to docker doc wording 2020-12-13 10:02:08 +10:00
Peter Feerick edc88b6042 Add Docker Hub info to docs and tweak instructions 2020-12-13 09:50:20 +10:00
JF a205509cbe Add new Getting started doc. 2020-11-20 18:36:39 +01:00
JF002 47a9297d05
Merge pull request #105 from Gottox/patch-1
Update MemoryAnalysis.md
2020-10-27 19:49:12 +01:00
Steveis cc7ba74790
Update arm-gcc toolchain in example
The difference in the example caused some confusion for at least one person.
2020-10-24 09:42:13 +01:00
Enno Boland e5efd0514a
Update MemoryAnalysis.md
typo fix: aray -> array
2020-10-19 21:26:13 +02:00
Maarten de Jong c4599dbf90
Fix typo
GCC output file is .out instead of .bin
2020-10-06 21:10:51 +02:00
JF e4f0a95af8 Add coding conventions in contribute.md 2020-10-04 12:52:48 +02:00
Avamander 9348f9936d Renamed documentation folder for consistency 2020-10-02 21:40:25 +03:00
JF 0e2a3d4394 Fix typo 2020-09-28 22:10:33 +02:00
JF002 e26a5afcac Add doc : using OpenOCD and STLinkV2 to flash the firmware 2020-09-28 22:07:54 +02:00
Rajesh Kumbhakar 08af5327bc Update buildAndProgram : Use latest ARM-GCC toolcahain to build.
Using the older (8.x.x) version of toolchain causes unexpected "template" errors, So we should always use version 9.x and above.
2020-09-24 10:09:42 +05:30
JF 0a1bebf1b7 Update links to Gadgetbridge, now that the support for Pinetime-JF/InfiniTime has been merge into the master branch. 2020-09-20 14:40:31 +02:00
JF 8d2e56bf00 Update to the latest version of the bootloader (https://github.com/lupyuen/pinetime-rust-mynewt/releases/tag/v5.0.4) 2020-09-20 11:29:56 +02:00
JF f197a3fe88 All output files (bin, hex, image, dfu) contain the version of the project in their filename.
Update Docker build script accordingly.
Also fix permission issue with docker build (all files belonged to root).
2020-08-19 21:52:46 +02:00
JF 58811d76cf Add doc about Docker image. 2020-08-19 16:01:01 +02:00
JF bfc3f07a37 Add doc about firmware validation 2020-08-14 21:46:34 +02:00
JF aab60cf137 Add missing pictures. 2020-08-10 17:03:30 +02:00
JF d8c2c9ad01 Add more doc about the bootloader (sequence diagrams and degraded cases). 2020-08-10 16:36:29 +02:00
JF 143d89a6a2 Fix typo in Amazfish.md 2020-08-08 20:31:00 +02:00
JF 8254622af5 Fix typo in buildAndProgram.md.
Add documentation about companion apps + link to videos.
2020-08-08 20:28:55 +02:00
JF 71e8c320b0 Merge branch 'develop' of git.proxmox3:JF/PineTime into develop
# Conflicts:
#	README.md
2020-07-27 21:25:00 +02:00
JF c04d22ee0a Add doc about the files included in the release notes. 2020-07-27 21:23:51 +02:00
JF002 8c77c8631d Add doc about branches, versioning and contributions 2020-07-26 16:15:12 +02:00
Seth Itow 381ac4d7da Edit README
- Fix markdown
- Copy edits for spelling and grammar
2020-07-22 15:33:57 -07:00
JF b9276a561c Rewrite README.md 2020-07-18 22:15:14 +02:00
JF ca549bcfd8 Add doc about memory usage analysis. 2020-07-03 14:45:01 +02:00
ToXIc e0307a8ee4
Links mixed up, fixed. 2020-04-05 21:15:52 +01:00
JF 932c0479ee Add documentation about BLE connection and services. 2020-04-05 17:03:06 +02:00
JF f07ffab4c1 Re-enable BLE, BLE status on display and battery level on display. 2020-02-23 16:14:03 +01:00
JF 27d0e1e02f Add documentation about building a stub using NRF52-DK. 2020-01-02 15:19:28 +01:00