79 lines
4 KiB
Markdown
79 lines
4 KiB
Markdown
# [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime)
|
||
|
||
[](https://github.com/InfiniTimeOrg/InfiniTime/actions)
|
||
|
||
|
||
|
||
InfiniTime is an open-source firmware for the [Pinetime smartwatch](https://www.pine64.org/pinetime/)
|
||
|
||
## New to InfiniTime?
|
||
|
||
- [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
|
||
- [About the software and updating](doc/gettingStarted/updating-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/xan-m/InfiniLink) **[Experimental]** (iOS)
|
||
|
||
## Documentation
|
||
|
||
### Develop
|
||
- [Coding conventions](/doc/coding-convention.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)
|
||
- [Creating a stopwatch in Pinetime(article)](https://pankajraghav.com/2021/04/03/PINETIME-STOPCLOCK.html)
|
||
- [Tips on designing an app UI](doc/ui_guidelines.md)
|
||
|
||
### Build, flash and debug
|
||
|
||
- [Project branches](doc/branches.md)
|
||
- [Versioning](doc/versioning.md)
|
||
- [Files included in the release notes](doc/filesInReleaseNotes.md)
|
||
- [Build the project](doc/buildAndProgram.md)
|
||
- [Flash the firmware using OpenOCD and STLinkV2](doc/openOCD.md)
|
||
- [Flash the firmware using SWD interface](doc/SWD.md)
|
||
- [Build the project with Docker](doc/buildWithDocker.md)
|
||
- [Build the project with VSCode](doc/buildWithVScode.md)
|
||
- [Bootloader, OTA and DFU](./bootloader/README.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)
|
||
|
||
## Contributing
|
||
|
||
This project is far from being finished, and there are still a lot of things to do for this project to become a firmware usable by the general public.
|
||
|
||
Do not hesitate to fork the code, hack it and create pull-requests! Make sure to read the [coding conventions](/doc/coding-convention.md)
|
||
|
||
You don't need to be a programmer to contribute. Read this page for more information on how you can help: [How to contribute?](doc/contribute.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 projects. 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!
|
||
|
||
*If you feel like you should appear on this list, just get in touch with me or submit a PR :)*
|