summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJF002 <JF002@users.noreply.github.com>2021-03-20 17:54:07 +0100
committerGitHub <noreply@github.com>2021-03-20 17:54:07 +0100
commit91ddc666e3ee1ac8fd128bf491f32d512e5524c3 (patch)
treed01afbe6f65a1564809a116cb8e2345522b05f3b /doc
parent405c85c160b0d72407498a25555677d484b822f1 (diff)
parentbca7ba4eed437361c93af6316b810e97dd071d67 (diff)
Merge pull request #235 from MFAshby/doc_correction
Small correction to git URL in documentation files
Diffstat (limited to 'doc')
-rw-r--r--doc/buildAndProgram.md4
-rw-r--r--doc/contribute.md4
-rw-r--r--doc/filesInReleaseNotes.md4
-rw-r--r--doc/gettingStarted/gettingStarted.md4
4 files changed, 8 insertions, 8 deletions
diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md
index 8d9c9382..484916a8 100644
--- a/doc/buildAndProgram.md
+++ b/doc/buildAndProgram.md
@@ -8,8 +8,8 @@ To build this project, you'll need:
## Build steps
### Clone the repo
```
-git clone https://github.com/JF002/Pinetime.git
-cd Pinetime
+git clone https://github.com/JF002/InfiniTime.git
+cd InfiniTime
git submodule update --init
mkdir build
cd build
diff --git a/doc/contribute.md b/doc/contribute.md
index 40441cd2..fe385125 100644
--- a/doc/contribute.md
+++ b/doc/contribute.md
@@ -1,6 +1,6 @@
# How to contribute?
## Report bugs
-You use your Pinetime and find a bug in the firmware? [Create an issue on Github](https://github.com/JF002/Pinetime/issues) explaining the bug, how to reproduce it, the version of the firmware you use...
+You use your Pinetime and find a bug in the firmware? [Create an issue on Github](https://github.com/JF002/InfiniTime/issues) explaining the bug, how to reproduce it, the version of the firmware you use...
## Write and improve documentation
Documentation might be incomplete, or not clear enough, and it is always possible to improve it with better wording, pictures, photo, video,...
@@ -41,4 +41,4 @@ The most important rule to follow is to try to keep the code as easy to read and
- **Include guard** : `#pragma once` (no `#ifdef __MODULE__ / #define __MODULE__ / #endif`)
- **Includes** :
- files from the project : `#include "relative/path/to/the/file.h"`
- - external files and std : `#include <file.h>` \ No newline at end of file
+ - external files and std : `#include <file.h>`
diff --git a/doc/filesInReleaseNotes.md b/doc/filesInReleaseNotes.md
index 2fdfadf4..f48a0c10 100644
--- a/doc/filesInReleaseNotes.md
+++ b/doc/filesInReleaseNotes.md
@@ -1,9 +1,9 @@
# Using the releases
-For each new *stable* version of Pinetime, a [release note](https://github.com/JF002/Pinetime/releases) is created. It contains a description of the main changes in the release and some files you can use to flash the firmware in your Pinetime.
+For each new *stable* version of Pinetime, a [release note](https://github.com/JF002/InfiniTime/releases) is created. It contains a description of the main changes in the release and some files you can use to flash the firmware in your Pinetime.
This page describes the files from the release notes and how to use them.
-**NOTE :** the files included in different could be different. This page describes the release note of [version 0.7.1](https://github.com/JF002/Pinetime/releases/tag/0.7.1), which is the version that'll probably be pre-programmed at the factory for the next batch of Pinetime devkits.
+**NOTE :** the files included in different could be different. This page describes the release note of [version 0.7.1](https://github.com/JF002/InfiniTime/releases/tag/0.7.1), which is the version that'll probably be pre-programmed at the factory for the next batch of Pinetime devkits.
## Files included in the release note
diff --git a/doc/gettingStarted/gettingStarted.md b/doc/gettingStarted/gettingStarted.md
index a3aa49ab..123bf4ae 100644
--- a/doc/gettingStarted/gettingStarted.md
+++ b/doc/gettingStarted/gettingStarted.md
@@ -8,7 +8,7 @@ If you just want to flash or upgrade InfiniTime on your PineTime, this page is f
- [How to flash InfiniTime using the SWD interface](#how-to-flash-infinitime-using-the-swd-interface)
## InfiniTime releases and versions
-All releases of InfiniTime are available on the [release page of the GitHub repo](https://github.com/JF002/Pinetime/releases).
+All releases of InfiniTime are available on the [release page of the GitHub repo](https://github.com/JF002/InfiniTime/releases).
Versions that are tagged as **RELEASE CANDIDATE** are pre-release versions, that are available for testing before actually releasing a new stable version. If you want to help us debug the project and provide stable versions to other user, you can use them. If you want stable and tested version, you should not flash these release candidate version.
@@ -98,4 +98,4 @@ Launch NRFConnect, tap the sandwish button on the top left and select *Configure
Tap *Add service* and select the server configuration *Current Time service*. Tap OK and connect to your PineTime, it should automcatically sync the time once the connection is established!
-![NRFConnect CTS 1](nrfconnectcts1.jpg) \ No newline at end of file
+![NRFConnect CTS 1](nrfconnectcts1.jpg)