diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 77 |
1 files changed, 39 insertions, 38 deletions
@@ -2,70 +2,71 @@ [](https://github.com/InfiniTimeOrg/InfiniTime/actions) - + 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) +- [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) +- [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) ## 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) - - [Versioning](doc/versioning.md) - - [Project branches](doc/branches.md) - - [Files included in the release notes](doc/filesInReleaseNotes.md) +- [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) +- [Versioning](doc/versioning.md) +- [Project branches](doc/branches.md) +- [Files included in the release notes](doc/filesInReleaseNotes.md) ### Contributing - - [How to contribute?](doc/contribute.md) - - [Coding conventions](doc/coding-convention.md) +- [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) +- [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) +- [BLE implementation and API](doc/ble.md) ### Architecture and technical topics - - [Memory analysis](doc/MemoryAnalysis.md) +- [Memory analysis](doc/MemoryAnalysis.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 + +- 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 @@ -73,6 +74,6 @@ I’m not working alone on this project. First, many people create PR for this p 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! +- [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! |