Add nix flakes support #2
14
README.md
14
README.md
@ -2,14 +2,20 @@
|
|||||||
|
|
||||||
MQTT-controlled 4-channel DDS signal generator using Urukul, Humpback and STM32 NUCLEO.
|
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)
|
- [Continuous Integration](https://nixbld.m-labs.hk/job/mcu/humpback-dds/humpback-dds)
|
||||||
- [Download latest firmware build](https://nixbld.m-labs.hk/job/stm32/stm32/humpback-dds/latest/download-by-type/file/binary-dist)
|
- [Download latest firmware build](https://nixbld.m-labs.hk/job/mcu/humpback-dds/humpback-dds/latest/download-by-type/file/binary-dist)
|
||||||
|
|
||||||
## Nix commands
|
## 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
|
```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.
|
**(For users who had completed the [networking setup](##networking-setup-for-first-time-user))** Flash firmware onto STM32 NUCLEO-H743ZI2 using OpenOCD.
|
||||||
|
Loading…
Reference in New Issue
Block a user