skyler
/
Lightningbeam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

note nam build requirements

This commit is contained in:
Skyler Lehmkuhl 2026-03-01 10:47:13 -05:00
parent 78577babb1
commit ae7ea1bb46
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/BUILDING.md
View File

@ -16,7 +16,12 @@ This guide provides detailed instructions for building Lightningbeam on differen
```bash
# Clone the repository
git clone https://github.com/skykooler/lightningbeam.git
cd lightningbeam/lightningbeam-ui
cd lightningbeam
# Initialize submodules (including nested ones required by nam-ffi)
git submodule update --init --recursive
cd lightningbeam-ui
# Build and run
cargo build
@ -270,6 +275,23 @@ cargo build -p lightningbeam-core
## Troubleshooting
### Submodule / CMake Issues
#### "does not contain a CMakeLists.txt file" (RTNeural or math_approx)
**Cause**: The `vendor/NeuralAudio` submodule has its own nested submodules (`deps/RTNeural`, `deps/math_approx`) that weren't initialized. A plain `git submodule update --init` only initializes top-level submodules.
**Solution**: Use `--recursive` to initialize all nested submodules:
```bash
git submodule update --init --recursive
```
Or, if the top-level submodule is already checked out:
```bash
cd vendor/NeuralAudio
git submodule update --init
```
### Audio Issues
#### "ALSA lib cannot find card" or similar errors