From a0dc0a5c88639085b5c488b61f78c2144ba58185 Mon Sep 17 00:00:00 2001 From: Abdelkader Boudih Date: Sat, 30 Aug 2025 14:23:47 +0100 Subject: [PATCH] Improve clone instructions with --recurse-submodules and namespaced directory --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 07a45781..6ae1900f 100644 --- a/README.md +++ b/README.md @@ -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