diff --git a/README.md b/README.md index 236b541a0..93c26ba83 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,29 @@ If you want to use the latest firmware version for your UHK, then instead of goi If you're one of the brave few who wants to hack the firmware then read on. +### UHK80 quick dev setup + +``` +mkdir west +cd west +git clone --recurse-submodules git@github.com:UltimateHackingKeyboard/firmware.git +cd firmware +./build.sh setup +./build.sh all build make flash +``` + +In case the above doesn't work, please see (or create a ticket): +- further sections of this readme +- content of `scripts/make-release.mjs` (this one is directive for build command form) +- content of `build.sh` (this is an auxiliary script; it works for me) + ### Fetching the codebase Note that these commands will create a [west workspace](https://docs.zephyrproject.org/latest/develop/west/workspaces.html#t2-star-topology-application-is-the-manifest-repository) in your current directory. ```bash +mkdir west +cd west git clone --recurse-submodules git@github.com:UltimateHackingKeyboard/firmware.git west init -l firmware west update diff --git a/build.sh b/build.sh index 7899a322a..0d4f33b07 100755 --- a/build.sh +++ b/build.sh @@ -243,6 +243,17 @@ function performAction() { rm -rf device/build .west bootloader modules nrf nrfxlib test tools zephyr ;; setup) + # basic dependencies + if ! command -v nrfutil &> /dev/null; + then + echo "Going to download nrfutil into /usr/local/bin. Please, either authorize it, or install nrfutil independently according to https://docs.nordicsemi.com/bundle/nrfutil/page/guides/installing.html" + sudo curl https://files.nordicsemi.com/artifactory/swtools/external/nrfutil/executables/x86_64-unknown-linux-gnu/nrfutil -o /usr/local/bin/nrfutil + sudo chmod +x /usr/local/bin/nrfutil + fi + pip3 install west + pip3 install -r scripts/requirements.txt + nrfutil install toolchain-manager + nrfutil toolchain-manager install --ncs-version $NCS_VERSION # update this according to README git submodule init git submodule update --init --recursive