InfiniTime/README.md

# [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime)

[![Build PineTime Firmware](https://github.com/InfiniTimeOrg/InfiniTime/workflows/Build%20PineTime%20Firmware/badge.svg?branch=master)](https://github.com/InfiniTimeOrg/InfiniTime/actions)

![InfiniTime logo](doc/logo/infinitime-logo-small.jpg "InfiniTime Logo")

Fast open-source firmware for the [PineTime smartwatch](https://www.pine64.org/pinetime/) with many features, written in modern C++.

## New to InfiniTime?

- [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
- [Updating the software](doc/gettingStarted/updating-software.md)
- [About the firmware and bootloader](doc/gettingStarted/about-software.md)

### Companion apps

- [Gadgetbridge](https://gadgetbridge.org/) (Android)
- [AmazFish](https://openrepos.net/content/piggz/amazfish/) (SailfishOS)
- [Siglo](https://github.com/alexr4535/siglo) (Linux)
- [InfiniLink](https://github.com/InfiniTimeOrg/InfiniLink) (iOS) **[Looking for a new maintainer]**
- [ITD](https://gitea.arsenm.dev/Arsen6331/itd) (Linux)

***Note** : We removed mentions to NRFConnect as this app is closed source and recent versions do not work anymore with InfiniTime (the last version known to work is 4.24.3). If you used NRFConnect in the past, we recommend you switch to [Gadgetbridge](https://gadgetbridge.org/).*

## Development

- [InfiniTime Vision](doc/InfiniTimeVision.md)
- [Rough structure of the code](doc/code/Intro.md)
- [How to implement an application](doc/code/Apps.md)
- [Generate the fonts and symbols](src/displayapp/fonts/README.md)
- [Tips on designing an app UI](doc/ui_guidelines.md)
- [Bootloader, OTA and DFU](bootloader/README.md)
- [External resources](doc/ExternalResources.md)

### Contributing

- [How to contribute?](doc/contribute.md)
- [Coding conventions](doc/coding-convention.md)

### Build, flash and debug

- [InfiniTime simulator](https://github.com/InfiniTimeOrg/InfiniSim)
- [Build the project](doc/buildAndProgram.md)
- [Build the project with Docker](doc/buildWithDocker.md)
- [Build the project with VSCode](doc/buildWithVScode.md)
- [Flash the firmware using OpenOCD and STLinkV2](doc/openOCD.md)
- [Flash the firmware using SWD interface](doc/SWD.md)
- [Flash the firmware using JLink](doc/jlink.md)
- [Flash the firmware using GDB](doc/gdb.md)
- [Stub using NRF52-DK](doc/PinetimeStubWithNrf52DK.md)

### API

- [BLE implementation and API](doc/ble.md)

### Architecture and technical topics

- [Memory analysis](doc/MemoryAnalysis.md)

### Project management

- [Maintainer's guide](doc/maintainer-guide.md)
- [Versioning](doc/versioning.md)
- [Project branches](doc/branches.md)
- [Files included in the release notes](doc/filesInReleaseNotes.md)

## Licenses

This project is released under the GNU General Public License version 3 or, at your option, any later version.

It integrates the following projects:

- RTOS : **[FreeRTOS](https://freertos.org)** under the MIT license
- UI : **[LittleVGL/LVGL](https://lvgl.io/)** under the MIT license
- BLE stack : **[NimBLE](https://github.com/apache/mynewt-nimble)** under the Apache 2.0 license
- Font : **[Jetbrains Mono](https://www.jetbrains.com/fr-fr/lp/mono/)** under the Apache 2.0 license

## Credits

I’m not working alone on this project. First, many people create PR for this project. Then, there is the whole #pinetime community : a lot of people all around the world who are hacking, searching, experimenting and programming the Pinetime. We exchange our ideas, experiments and code in the chat rooms and forums.

Here are some people I would like to highlight:

- [Atc1441](https://github.com/atc1441/) : He works on an Arduino based firmware for the Pinetime and many other smartwatches based on similar hardware. He was of great help when I was implementing support for the BMA421 motion sensor and I²C driver.
- [Koen](https://github.com/bosmoment) : He’s working on a firmware based on RiotOS. He integrated similar libs as me : NimBLE, LittleVGL,… His help was invaluable too!
- [Lup Yuen Lee](https://github.com/lupyuen) : He is everywhere: he works on a Rust firmware, builds a MCUBoot based bootloader for the Pinetime, designs a Flutter based companion app for smartphones and writes a lot of articles about the Pinetime!
-												Documentation cleanup and reorganization

											
										
										
											2021-11-06 13:38:11 +01:00
+								# [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime)
-												Update README.md

add ci badge.
											
										
										
											2020-07-28 22:51:14 +02:00
-												Replaced "JF002" in github URLs with "InfiniTimeOrg"

											
										
										
											2021-10-15 18:03:10 +02:00
+								[![Build PineTime Firmware](https://github.com/InfiniTimeOrg/InfiniTime/workflows/Build%20PineTime%20Firmware/badge.svg?branch=master)](https://github.com/InfiniTimeOrg/InfiniTime/actions)
-												Update README.md

add ci badge.
											
										
										
											2020-07-28 22:51:14 +02:00
-												Move all images to doc. Remove old images. (#1282)


											
										
										
											2022-08-21 13:42:53 +02:00
+								![InfiniTime logo](doc/logo/infinitime-logo-small.jpg "InfiniTime Logo")
-												Add InfiniTime logo.

											
										
										
											2020-08-02 18:09:38 +02:00
-												Split updating and about software. Remove big Contributing section from README

											
										
										
											2021-11-14 14:23:12 +01:00
+								Fast open-source firmware for the [PineTime smartwatch](https://www.pine64.org/pinetime/) with many features, written in modern C++.
-												Rewrite README.md

											
										
										
											2020-07-18 22:15:14 +02:00
-												Move getting started slightly lower

											
										
										
											2021-08-03 18:51:58 +02:00
+								## New to InfiniTime?
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
 								- [Updating the software](doc/gettingStarted/updating-software.md)
 								- [About the firmware and bootloader](doc/gettingStarted/about-software.md)
-												Docs reorganization (#1236)

* Docs reorganization

Removed broken link

* README.md relative link consistency
											
										
										
											2022-07-21 22:02:33 +02:00
-												Link to companion apps

											
										
										
											2021-11-08 16:42:42 +01:00
+								### Companion apps
-												Docs reorganization (#1236)

* Docs reorganization

Removed broken link

* README.md relative link consistency
											
										
										
											2022-07-21 22:02:33 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [Gadgetbridge](https://gadgetbridge.org/) (Android)
 								- [AmazFish](https://openrepos.net/content/piggz/amazfish/) (SailfishOS)
 								- [Siglo](https://github.com/alexr4535/siglo) (Linux)
 								- [InfiniLink](https://github.com/InfiniTimeOrg/InfiniLink) (iOS) **[Looking for a new maintainer]**
 								- [ITD](https://gitea.arsenm.dev/Arsen6331/itd) (Linux)
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Add a note in README.md regarding NRFConnect (not supported anymore).

											
										
										
											2022-11-06 15:50:37 +01:00
+								***Note** : We removed mentions to NRFConnect as this app is closed source and recent versions do not work anymore with InfiniTime (the last version known to work is 4.24.3). If you used NRFConnect in the past, we recommend you switch to [Gadgetbridge](https://gadgetbridge.org/).*
-												Split updating and about software. Remove big Contributing section from README

											
										
										
											2021-11-14 14:23:12 +01:00
+								## Development
-												Add doc about the files included in the release notes.

											
										
										
											2020-07-27 21:23:51 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [InfiniTime Vision](doc/InfiniTimeVision.md)
 								- [Rough structure of the code](doc/code/Intro.md)
 								- [How to implement an application](doc/code/Apps.md)
 								- [Generate the fonts and symbols](src/displayapp/fonts/README.md)
 								- [Tips on designing an app UI](doc/ui_guidelines.md)
 								- [Bootloader, OTA and DFU](bootloader/README.md)
-												Add doc about external resources.

											
										
										
											2022-10-02 12:27:10 +02:00
+								- [External resources](doc/ExternalResources.md)
-												CI: add lv_sim workflow and upload 'infinisim' executable

use InfiniSim repo to build simulator in CI

											
										
										
											2022-02-01 21:48:56 +01:00
-												Split updating and about software. Remove big Contributing section from README

											
										
										
											2021-11-14 14:23:12 +01:00
+								### Contributing
-												Docs reorganization (#1236)

* Docs reorganization

Removed broken link

* README.md relative link consistency
											
										
										
											2022-07-21 22:02:33 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [How to contribute?](doc/contribute.md)
 								- [Coding conventions](doc/coding-convention.md)
-												Split updating and about software. Remove big Contributing section from README

											
										
										
											2021-11-14 14:23:12 +01:00
-												Rewrite README.md

											
										
										
											2020-07-18 22:15:14 +02:00
+								### Build, flash and debug
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [InfiniTime simulator](https://github.com/InfiniTimeOrg/InfiniSim)
 								- [Build the project](doc/buildAndProgram.md)
 								- [Build the project with Docker](doc/buildWithDocker.md)
 								- [Build the project with VSCode](doc/buildWithVScode.md)
 								- [Flash the firmware using OpenOCD and STLinkV2](doc/openOCD.md)
 								- [Flash the firmware using SWD interface](doc/SWD.md)
 								- [Flash the firmware using JLink](doc/jlink.md)
 								- [Flash the firmware using GDB](doc/gdb.md)
 								- [Stub using NRF52-DK](doc/PinetimeStubWithNrf52DK.md)
-												Add doc about branches, versioning and contributions

											
										
										
											2020-07-26 16:15:12 +02:00
-												Rewrite README.md

											
										
										
											2020-07-18 22:15:14 +02:00
+								### API
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [BLE implementation and API](doc/ble.md)
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Rewrite README.md

											
										
										
											2020-07-18 22:15:14 +02:00
+								### Architecture and technical topics
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [Memory analysis](doc/MemoryAnalysis.md)
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												readme: Add Project management section

The list of development docs was getting long, so move docs more
intended for maintainers to a separate section.

											
										
										
											2023-01-15 09:41:10 +01:00
+								### Project management
 								- [Maintainer's guide](doc/maintainer-guide.md)
 								- [Versioning](doc/versioning.md)
 								- [Project branches](doc/branches.md)
 								- [Files included in the release notes](doc/filesInReleaseNotes.md)
-												Add LICENSE file and information.

											
										
										
											2020-08-02 17:38:51 +02:00
+								## Licenses
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
-												Add LICENSE file and information.

											
										
										
											2020-08-02 17:38:51 +02:00
+								This project is released under the GNU General Public License version 3 or, at your option, any later version.
 								It integrates the following projects:
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
 								- RTOS : **[FreeRTOS](https://freertos.org)** under the MIT license
 								- UI : **[LittleVGL/LVGL](https://lvgl.io/)** under the MIT license
 								- BLE stack : **[NimBLE](https://github.com/apache/mynewt-nimble)** under the Apache 2.0 license
 								- Font : **[Jetbrains Mono](https://www.jetbrains.com/fr-fr/lp/mono/)** under the Apache 2.0 license
-												Update documentation (#467)

* Fix and update documentation
* Add newlines
											
										
										
											2021-07-25 17:50:55 +02:00
 								## Credits
-												minor grammar edit
											
										
										
											2023-01-20 03:52:57 +01:00
+								I’m not working alone on this project. First, many people create PR for this project. Then, there is the whole #pinetime community : a lot of people all around the world who are hacking, searching, experimenting and programming the Pinetime. We exchange our ideas, experiments and code in the chat rooms and forums.
-												Update Readme, add section about BLE connection troubleshooting

											
										
										
											2020-03-29 15:19:39 +02:00
-												Rewrite README.md

											
										
										
											2020-07-18 22:15:14 +02:00
+								Here are some people I would like to highlight:
-												Update Readme, add section about BLE connection troubleshooting

											
										
										
											2020-03-29 15:19:39 +02:00
-												Fix markdown format with autoformatter (#1284)


											
										
										
											2022-08-21 13:50:09 +02:00
+								- [Atc1441](https://github.com/atc1441/) : He works on an Arduino based firmware for the Pinetime and many other smartwatches based on similar hardware. He was of great help when I was implementing support for the BMA421 motion sensor and I²C driver.
 								- [Koen](https://github.com/bosmoment) : He’s working on a firmware based on RiotOS. He integrated similar libs as me : NimBLE, LittleVGL,… His help was invaluable too!
 								- [Lup Yuen Lee](https://github.com/lupyuen) : He is everywhere: he works on a Rust firmware, builds a MCUBoot based bootloader for the Pinetime, designs a Flutter based companion app for smartphones and writes a lot of articles about the Pinetime!