summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorluz paz <luzpaz@github.com>2022-05-31 15:17:36 -0400
committerRiku Isokoski <riksu9000@gmail.com>2022-06-05 09:31:23 +0300
commit03a510bd182cdb89005d75e0f8dacf734efce315 (patch)
tree581d6638c06a2211c2d154e69cf66d702e1de818 /doc
parent7f45538eb53235ab4015fcf13533796c8759c7bc (diff)
Fix various typos
Found via `codespell -q 3 -S ./src/libs -L ans,doubleclick,trough`
Diffstat (limited to 'doc')
-rw-r--r--doc/MemoryAnalysis.md4
-rw-r--r--doc/NavigationService.md2
-rw-r--r--doc/PinetimeStubWithNrf52DK.md2
-rw-r--r--doc/ble.md6
-rw-r--r--doc/ble/connection_sequence.puml2
-rw-r--r--doc/branches.md2
-rw-r--r--doc/buildAndProgram.md2
7 files changed, 10 insertions, 10 deletions
diff --git a/doc/MemoryAnalysis.md b/doc/MemoryAnalysis.md
index 376f98f6..9afca4e7 100644
--- a/doc/MemoryAnalysis.md
+++ b/doc/MemoryAnalysis.md
@@ -60,7 +60,7 @@ Puncover is really easy to install:
- Launch a browser at http://localhost:5000/
### Analysis
-Using the MAP file and tools, we can easily see what symbols are using most of the flash memory. In this case, unsuprisingly, fonts and graphics are the largest use of flash memory.
+Using the MAP file and tools, we can easily see what symbols are using most of the flash memory. In this case, unsurprisingly, fonts and graphics are the largest use of flash memory.
![Puncover](./memoryAnalysis/puncover-all-symbols.png)
@@ -150,7 +150,7 @@ You can then display the file using objdump:
hexdump ram.bin -v | less
```
-The stack is positionned at the end of the RAM -> 0xFFFF. Its size is 8192 bytes, so the end of the stack is at 0xE000.
+The stack is positioned at the end of the RAM -> 0xFFFF. Its size is 8192 bytes, so the end of the stack is at 0xE000.
On the following dump, the maximum stack usage is 520 bytes (0xFFFF - 0xFDF8):
```
diff --git a/doc/NavigationService.md b/doc/NavigationService.md
index 5a4f69e0..d890cb26 100644
--- a/doc/NavigationService.md
+++ b/doc/NavigationService.md
@@ -13,7 +13,7 @@ The service UUID is 00010000-78fc-48fe-8e23-433b3a1942d0
## Characteristics
## Flags (UUID 00010001-78fc-48fe-8e23-433b3a1942d0)
-All included icons are from pure-maps, which provides the actual routing from the client. The icon names ultimately come from the mapbox project "direction-icons", See https://github.com/rinigus/pure-maps/tree/master/qml/icons/navigation See the end of this document for the full lsit of supported icon names.
+All included icons are from pure-maps, which provides the actual routing from the client. The icon names ultimately come from the mapbox project "direction-icons", See https://github.com/rinigus/pure-maps/tree/master/qml/icons/navigation See the end of this document for the full list of supported icon names.
## Narrative (UUID 00010002-78fc-48fe-8e23-433b3a1942d0)
This is a client supplied string describing the upcoming instruction such as "At the roundabout take the first exit".
diff --git a/doc/PinetimeStubWithNrf52DK.md b/doc/PinetimeStubWithNrf52DK.md
index dcaad69b..afa8a74d 100644
--- a/doc/PinetimeStubWithNrf52DK.md
+++ b/doc/PinetimeStubWithNrf52DK.md
@@ -1,5 +1,5 @@
# Build a stub for PineTime using NRF52-DK
-[NRF52-DK](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52-DK) is the official developpment kit for the NRF52832 SoC from Nordic Semiconductor used in the PineTime.
+[NRF52-DK](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52-DK) is the official development kit for the NRF52832 SoC from Nordic Semiconductor used in the PineTime.
This development kit can be very useful for PineTime development:
* You can use its embedded JLink SWD programmer/debugger to program and debug your code on the PineTime
diff --git a/doc/ble.md b/doc/ble.md
index d2502636..8d59c2ef 100644
--- a/doc/ble.md
+++ b/doc/ble.md
@@ -44,7 +44,7 @@ When starting, the firmware starts BLE advertising. It sends small messages that
A companion application (running on a PC, Raspberry Pi, smartphone, etc.) which receives this advertising packet can request a connection to the device. This connection procedure allows the 2 devices to negotiate communication parameters, security keys, etc.
-When the connection is established, the PineTime will try to discover services running on the companion application. For now **CTS** (**C**urrent **T**ime **S**ervice) and **ANS** (**A**lert **N**otification **S**ervice) are supported.
+When the connection is established, the PineTime will try to discover services running on the companion application. For now **CTS** (**C**urrent **T**ime **S**ervice) and **ANS** (**A**lert **N**notification **S**ervice) are supported.
If **CTS** is detected, it'll request the current time to the companion application. If **ANS** is detected, it will listen to new notifications coming from the companion application.
@@ -146,14 +146,14 @@ The new alert characteristic allows sending new notifications to InfiniTime. It
For example, here is what a normal notification looks like in Golang (language of `itd`):
```go
-// \x00 is the category for simple alert, and there is one new notifcation, hence \x01.
+// \x00 is the category for simple alert, and there is one new notification, hence \x01.
"\x00\x01\x00Test Title\x00Test Body"
```
A call notification looks like so:
```go
-// \x03 is the category for calls, and there is one new call notifcation, hence \x01.
+// \x03 is the category for calls, and there is one new call notification, hence \x01.
"\x03\x01\x00Mary"
```
diff --git a/doc/ble/connection_sequence.puml b/doc/ble/connection_sequence.puml
index 55531829..b71a3410 100644
--- a/doc/ble/connection_sequence.puml
+++ b/doc/ble/connection_sequence.puml
@@ -3,7 +3,7 @@ Pinetime --> CompanionApp: Start advertising
group BLE Connection
CompanionApp -> Pinetime: Connection request
-CompanionApp <-> Pinetime: Connection parameters negociation, security procedure,...
+CompanionApp <-> Pinetime: Connection parameters negotiation, security procedure,...
end
group Service Discovery
diff --git a/doc/branches.md b/doc/branches.md
index 3c86375f..c12c764a 100644
--- a/doc/branches.md
+++ b/doc/branches.md
@@ -5,7 +5,7 @@ The project is based on 2 main branches:
- **master** : this branch is always ready to be deployed. It means that at any time, we should be able to build the branch and release a new version of the application.
- **develop** : this branch contains the latest development that will be integrated in the next release once it's considered as stable.
-New features should be implemented in **feature branches** created from **develop**. When the feature is ready, a pull-request is created and it'll be merge into **develop** when it is succesfully reviewed and accepted.
+New features should be implemented in **feature branches** created from **develop**. When the feature is ready, a pull-request is created and it'll be merge into **develop** when it is successfully reviewed and accepted.
To release a new version of the application, when develop is considered stable, a **release** branch is created from **develop**. This can be considered as a *release candidate* branch. When everything is OK, this release branch is merged into **master** and the release is generated (a tag is applied to git, the release note is finalized, binaries are built,...) from **master**.
diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md
index 683f539d..6362235b 100644
--- a/doc/buildAndProgram.md
+++ b/doc/buildAndProgram.md
@@ -47,7 +47,7 @@ By default, this variable is set to *Release*. It compiles the code with size an
The *Debug* mode disables all optimizations, which makes the code easier to debug. However, the binary size will likely be too big to fit in the internal flash memory. If you want to build and debug a *Debug* binary, you'll need to disable some parts of the code. For example, the icons for the **Navigation** app use a lot of memory space. You can comment the content of `m_iconMap` in the [Navigation](https://github.com/InfiniTimeOrg/InfiniTime/blob/develop/src/displayapp/screens/Navigation.h#L148) application to free some memory.
####(**) Note about **BUILD_DFU**:
-DFU files are the files you'll need to install your build of InfiniTime using OTA (over-the-air) mecanism. To generate the DFU file, the Python tool [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil) is needed on your system. Check that this tool is properly installed before enabling this option.
+DFU files are the files you'll need to install your build of InfiniTime using OTA (over-the-air) mechanism. To generate the DFU file, the Python tool [adafruit-nrfutil](https://github.com/adafruit/Adafruit_nRF52_nrfutil) is needed on your system. Check that this tool is properly installed before enabling this option.
#### CMake command line for JLink
```