From 237578a1b6fbd0494cb7bb4f0d95ad9a26546d9f Mon Sep 17 00:00:00 2001 From: mwojcik Date: Wed, 19 Jan 2022 16:27:20 +0800 Subject: [PATCH] readme: update CI links, build/dev instructions --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6e7e659..b0fff62 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,20 @@ MQTT-controlled 4-channel DDS signal generator using Urukul, Humpback and STM32 NUCLEO. -- [Continuous Integration](https://nixbld.m-labs.hk/job/stm32/stm32/humpback-dds) -- [Download latest firmware build](https://nixbld.m-labs.hk/job/stm32/stm32/humpback-dds/latest/download-by-type/file/binary-dist) +- [Continuous Integration](https://nixbld.m-labs.hk/job/mcu/humpback-dds/humpback-dds) +- [Download latest firmware build](https://nixbld.m-labs.hk/job/mcu/humpback-dds/humpback-dds/latest/download-by-type/file/binary-dist) ## Nix commands -Start nix shell before anything. +Humpback-DDS firmware is packaged using the [Nix](https://nixos.org) Flakes system. Install Nix 2.4+ and enable flakes by adding ``experimental-features = nix-command flakes`` to ``nix.conf`` (e.g. ``~/.config/nix/nix.conf``). + +Once you have Flakes enabled, you can use ``nix build`` to build the firmware. + +Alternatively, you can develop and build it within Nix shell: ```shell -nix-shell +nix develop +python fpga/fpga_config.py +cargo build --release ``` **(For users who had completed the [networking setup](##networking-setup-for-first-time-user))** Flash firmware onto STM32 NUCLEO-H743ZI2 using OpenOCD.