https://github.com/headblockhead/squirrel
A library for keyboards. Used by my Slab keyboard system.
https://github.com/headblockhead/squirrel
c cmake keyboard library
Last synced: 10 months ago
JSON representation
A library for keyboards. Used by my Slab keyboard system.
- Host: GitHub
- URL: https://github.com/headblockhead/squirrel
- Owner: headblockhead
- License: cc0-1.0
- Created: 2023-12-23T13:56:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-01T00:22:53.000Z (about 1 year ago)
- Last Synced: 2025-06-01T10:57:50.856Z (about 1 year ago)
- Topics: c, cmake, keyboard, library
- Language: C
- Homepage:
- Size: 192 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQUIRREL - Simplified, runtime-configurable QMK as a library
or: Simplified QMK Uniquely Immaculate (and) Readable Runtime Editable Library
🚧 This project is currently **under construction**, so do not expect a usable result yet! 🚧
## Goals:
- Create an easy to understand and simple keyboard library that allows for runtime layout and configuration edits.
- Make sure it is as documented and clearly organised as possible.
- Keep it independent of any microcontroller.
For an example implementation of SQUIRREL, see the [SQUIRREL-pico](https://github.com/headblockhead/SQUIRREL-pico) example template.
## Development
SQUIRREL uses [nix](https://nixos.org).
To develop, run the nix shell using `nix develop`. SQUIRREL can also be built using `nix build`.
## Tasks
### Build
Directory: ./build
Builds a static archive library (`.a`).
```bash
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j4
```
### Build-debug
Directory: ./build
Builds the library with debug build type.
```bash
cmake -DCMAKE_BUILD_TYPE=Debug ..
make -j4
cp compile_commands.json ../ # Copies the autocomplete information for ccls.
```
### Test
Directory: ./build
Tests the library
```bash
cmake -DCMAKE_BUILD_TYPE=Testing ..
make -j4
ctest -T Test -T Coverage --output-on-failure .
```
### Clean
Cleans the build directory for a fresh build.
```bash
rm -rf ./build
mkdir build
```