Skip to content

Improve clone instructions with --recurse-submodules #302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve clone instructions with --recurse-submodules #302

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,15 @@ The nRF52 is designed to handle the overall system operation. It runs Lua, as we
./nrfutil install nrf5sdk-tools
```

1. Clone this repository and initialize any submodules:
1. Clone this repository with submodules:

```sh
git clone https://github.com/brilliantlabsAR/frame-codebase.git
git clone --recurse-submodules https://github.com/brilliantlabsAR/frame-codebase.git brilliantlabs-frame-codebase

cd frame-codebase

git submodule update --init
cd brilliantlabs-frame-codebase
```

1. You should now be able to build and flash the project to an [nRF52840 DK](https://www.nordicsemi.com/Products/Development-hardware/nRF52840-DK) by calling the following commands from the `frame-codebase` folder.
1. You should now be able to build and flash the project to an [nRF52840 DK](https://www.nordicsemi.com/Products/Development-hardware/nRF52840-DK) by calling the following commands from the `brilliantlabs-frame-codebase` folder.

```sh
make release
Expand Down