Convenience Scripts

Copyright 2023 Travis J. West, https://traviswest.ca, Input Devices and Music Interaction Laboratory (IDMIL), Centre for Interdisciplinary Research in Music Media and Technology (CIRMMT), McGill University, Montréal, Canada, and Univ. Lille, Inria, CNRS, Centrale Lille, UMR 9189 CRIStAL, F-59000 Lille, France

SPDX-License-Identifier: MIT

Several convenience scripts are provided to facilitate development. When the nix shell environment is activated by running nix-shell --pure, these can be run directly, e.g. test.sh, since the sh directory is prepended to the binary search path. Alternatively, you may run ‘nix-shell --pure --run 'script.sh’` to run a given script without dropping into the nix shell environment.

• sh/lili.sh Literate Programming Convenience Script
  • Run lili on each literate source file that has been update, regenerating tangled machine code
  • This script automatically calls the following scripts that generally needn't be called directly:
    • generate_components_cmake.sh Automated CMake Component List
    • page-sh-generate_implementation_index
• sh/test.sh Test Runner Convenience Script
  • Compile and run tests for portable components.
• sh/new_component.sh New Component Convenience Script
  • Automatically generate the skeleton of a new component. See Making a New Component for more details.
• sh/update_docs.sh Documentation Convenience Script
  • Update the doxygen documentation website repository
• sh/idf.sh ESP-IDF Convenience Script
  • Install the ESP-IDF and build an IDF-based instrument firmware.
• sh/pico_sdk.sh Raspberry Pi Pico SDK Convenience Script
  • Install the Raspberry Pi Pico SDK and build a Pico SDK-based instrument firmware.