summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJF002 <JF002@users.noreply.github.com>2021-09-12 18:00:10 +0200
committerGitHub <noreply@github.com>2021-09-12 18:00:10 +0200
commit977321cf6457eefed7fe0cea0fb9b94c2fddf7fd (patch)
tree6ad0170dcf73bb9394cca7fb9c4239d21f1a796a /README.md
parent1235c697c4446a8ae3d1c69aee646fb035f67f89 (diff)
parent285ac9e4c86f6f1fb96130d2df038fff7ec49ad5 (diff)
Merge pull request #552 from Riksu9000/new_to_infinitime
Make README more friendly for new users.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 7 insertions, 17 deletions
diff --git a/README.md b/README.md
index 86f1b9dd..0d5cad93 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,10 @@
-# PineTime
+# InfiniTime
[![Build PineTime Firmware](https://github.com/JF002/InfiniTime/workflows/Build%20PineTime%20Firmware/badge.svg?branch=master)](https://github.com/JF002/InfiniTime/actions)
-> The PineTime is a free and open source smartwatch capable of running custom-built open operating systems. Some of the notable features include a heart rate monitor, a week-long battery as well as a capacitive touch IPS display that is legible in direct sunlight. It is a fully community driven side-project, which means that it will ultimately be up to the developers and end-users to determine when they deem the PineTime ready to ship.
-
-> We envision the PineTime as a companion for not only your PinePhone but also for your favorite devices — any phone, tablet, or even PC.
-
-*https://www.pine64.org/pinetime/*
-
-The **Pinetime** smartwatch is built around the NRF52832 MCU (512KB Flash, 64KB RAM), a 240*240 LCD display driven by the ST7789 controller, an accelerometer, a heart rate sensor, and a vibration motor.
-
-# InfiniTime
-
![InfiniTime logo](images/infinitime-logo.jpg "InfiniTime Logo")
-The goal of this project is to design an open-source firmware for the Pinetime smartwatch :
+The goal of this project is to design an open-source firmware for the [Pinetime smartwatch](https://www.pine64.org/pinetime/) :
- Code written in **modern C++**;
- Build system based on **CMake**;
@@ -22,6 +12,11 @@ The goal of this project is to design an open-source firmware for the Pinetime s
- Using **[LittleVGL/LVGL 7](https://lvgl.io/)** as UI library...
- ... and **[NimBLE 1.3.0](https://github.com/apache/mynewt-nimble)** as BLE stack.
+## New to InfiniTime?
+
+ - [Getting started with InfiniTime 1.0 (quick user guide, update bootloader and InfiniTime,...)](doc/gettingStarted/gettingStarted-1.0.md)
+ - [Flash, upgrade (OTA), time synchronization,...](doc/gettingStarted/ota-gadgetbridge-nrfconnect.md)
+
## Overview
![Pinetime screens](images/1.0.0/collage.png "PinetimeScreens")
@@ -76,11 +71,6 @@ As of now, here is the list of achievements of this project:
## Documentation
-### Getting started
-
- - [Getting started with InfiniTime 1.0 (quick user guide, update bootloader and InfiniTime,...)](doc/gettingStarted/gettingStarted-1.0.md)
- - [Flash, upgrade (OTA), time synchronization,...](doc/gettingStarted/ota-gadgetbridge-nrfconnect.md)
-
### Develop
- [Generate the fonts and symbols](src/displayapp/fonts/README.md)