Skip to content

Commit

Permalink
Updates docs to redirect to readme
Browse files Browse the repository at this point in the history
Signed-off-by: simonmicro <simon@simonmicro.de>
  • Loading branch information
simonmicro committed Aug 11, 2024
1 parent c51f31e commit e0f2cb0
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/firmware/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,10 @@ Open git bash in your desired folder and clone the source code repository **recu

git clone --recurse-submodules https://github.com/Open-Smartwatch/open-smartwatch-os.git

If you have cloned the repo without the recurse option, run `git submodule update`.
If you have cloned the repo without the recurse option, run `git submodule update --init`.

!!! note "Tip"
After changing or updating/pulling a branch, run the command again to also update dependencies:
```bash
git pull
git submodule update --init --recursive
```
After changing or updating/pulling a branch, run the commands notes inside the `README.md` to update the submodules and the PlatformIO packages.

Then, open the directory with Visual Studio Code.

Expand All @@ -68,4 +64,4 @@ Generally, you won't need to worry about GPIO assignment and initialisation as t

**Keep in mind the PCB is flipped when inserted into the watch, EN/Reset is at the top left in this case:**

<img src="/assets/uploading.jpg" width="512px"/>
<img src="/assets/uploading.jpg" width="512px"/>

0 comments on commit e0f2cb0

Please sign in to comment.