logos-blockchain/logos-blockchain-module
1
0
Fork 0
mirror of https://github.com/logos-blockchain/logos-blockchain-module.git synced 2026-05-23 17:49:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add nix + ide integration documentation.

Browse Source
This commit is contained in:
Alejandro Cabeza Romero 2026-04-03 12:56:14 +02:00
parent 0b23cbe85f
commit 189f23bef9
No known key found for this signature in database
GPG Key ID: DA3D14AE478030FD
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -14,3 +14,25 @@ This will reduce friction when working on the project.
* Use `nix build` to build the package * Use `nix build` to build the package
* Use `nix run` to launch the module-viewer and check your module loads properly * Use `nix run` to launch the module-viewer and check your module loads properly
* Use `nix develop` to setup your IDE * Use `nix develop` to setup your IDE
### Troubleshooting
#### Nix + IDE Integration
If your IDE reports that a file doesn't belong to the project or that files cannot be found, the CMake cache
is likely missing the Nix-provided paths. This happens when the IDE runs CMake on its own, outside the Nix
environment, leaving the required paths empty.
To fix it:
1. **Regenerate the cache from within the Nix shell**
This provides the required Nix paths and writes them into `build/CMakeCache.txt`:
```bash
nix develop -c just configure
```
2. **Reload the CMake project without resetting the cache**
If on RustRover: Open the CMake tool window (**View → Tool Windows → CMake**) and click the **Reload** button (↺) in the toolbar.
> Resetting the cache would wipe the paths you just wrote, so make sure to reload only.