summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 00000000..8747dcc6
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,36 @@
+= InfiniTime
+
+image::doc/logo/infinitime-logo-small.jpg[InfiniTime Logo]
+
+A unofiicial fork of the fast open-source firmware for the https://www.pine64.org/pinetime[PineTime smartwatch] with many features, written in modern C++.
+
+This repository is for pesonal use and modified to my liking. Contributions should go to the https://github.com/InfiniTimeOrg/InfiniTime[official repository]. You will find more information on the project there, too.
+
+== 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)
+
+== Architecture and technical topics
+
+- [BLE implementation and API](doc/ble.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
+