summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSeth Itow <11025699+sethitow@users.noreply.github.com>2020-07-22 22:33:57 (GMT)
committerSeth Itow <11025699+sethitow@users.noreply.github.com>2020-07-22 22:33:57 (GMT)
commit381ac4d7dadd07d5bc7acef6596e5910bd2b105f (patch)
tree9aa809a8947435f8cab7647c5ef6b4f627ae2f0a /README.md
parentb33ad9260026fce5d8d03080013eb96c3f7c3a3b (diff)
Edit README
- Fix markdown - Copy edits for spelling and grammar
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index 643c371..82cf1f8 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
*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 heartrate sensor and a vibrator.
+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.
The goal of this project is to design an open-source firmware for the Pinetime smartwatch :
@@ -15,7 +15,7 @@ The goal of this project is to design an open-source firmware for the Pinetime s
- Using **[LittleVGL/LVGL 6.1.2](https://lvgl.io/)** as UI library...
- ... and **[NimBLE 1.3.0](https://github.com/apache/mynewt-nimble)** as BLE stack.
-##Overview
+## Overview
![Pinetime screens](images/0.7.0/montage.jpg "PinetimeScreens")
@@ -23,16 +23,16 @@ As of now, here is the list of achievements of this project:
- Fast and optimized LCD driver
- BLE communication
- - Rich user interface via display, touchpanel and push button
- - Time synchronisation via BLE
+ - Rich user interface via display, touch panel and push button
+ - Time synchronization via BLE
- Notification via BLE
- - Multiple 'apps' :
+ - Multiple 'apps':
* Clock (displays the date, time, battery level, ble connection status, heart rate and step count)
* Heart rate
* Motion
- * System info (displays various info : BLE MAC, build date/time, uptime, version,...)
- * Brightess (allows the user to configure the brightness of the display)
- - Supported by 2 companion apps (developpments ongoing):
+ * System info (displays various info: BLE MAC, build date/time, uptime, version, ...)
+ * Brightness (allows the user to configure the brightness of the display)
+ - Supported by 2 companion apps (developments ongoing):
* [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/branch/pinetime-jf) (on Android)
* [Amazfish](https://openrepos.net/content/piggz/amazfish) (on SailfishOS)
- **[Experimental]** OTA (Over-the-air) update via BLE
@@ -61,19 +61,19 @@ As of now, here is the list of achievements of this project:
## TODO - contribute
-This project is far from beeing finished, and there are still a lot of things to do for this project to become a firmware usable by the general public.
+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.
Here a quick list out of my head of things to do for this project:
- Improve BLE communication stability and reliability
- Improve OTA and MCUBoot bootloader
- - Add more functionalities : Alarm, chrono, configuration, activities, heart rate logging, games,...
+ - Add more functionalities : Alarm, chronometer, configuration, activities, heart rate logging, games,...
- Add more BLE functionalities : call notifications, agenda, configuration, data logging,...
- Measure power consumption and improve battery life
- Improve documentation, take better pictures and video than mine
- Improve the UI
- Create companion app for multiple OSes (Linux, Android, IoS) and platforms (desktop, ARM, mobile). Do not forget the other devices from Pine64 like [the Pinephone](https://www.pine64.org/pinephone/) and the [Pinebook Pro](https://www.pine64.org/pinebook-pro/).
- - Design a simple CI (preferably selfhosted and easy to reproduce).
+ - Design a simple CI (preferably self-hosted and easy to reproduce).
Do not hesitate to clone/fork the code, hack it and create pull-requests. I'll do my best to review and merge them :)
@@ -84,6 +84,6 @@ 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 than me : NimBLE, LittleVGL,… His help was invaluable too!
- - [Lup Yuen Lee](https://github.com/lupyuen) : He is everywhere : he works on a Rust firmware, buils a MCUBoot based bootloader for the Pinetime, design a Flutter based companion app for smartphones and write a lot of articles about the Pinetime!
+ - [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 :)*