{"id":20383067,"url":"https://github.com/headblockhead/squirrel","last_synced_at":"2025-09-01T02:40:58.914Z","repository":{"id":213850035,"uuid":"735053962","full_name":"headblockhead/SQUIRREL","owner":"headblockhead","description":"A library for keyboards. Used by my Slab keyboard system.","archived":false,"fork":false,"pushed_at":"2025-06-01T00:22:53.000Z","size":197,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-01T10:57:50.856Z","etag":null,"topics":["c","cmake","keyboard","library"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/headblockhead.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-23T13:56:27.000Z","updated_at":"2025-03-16T19:38:32.000Z","dependencies_parsed_at":"2024-08-25T22:46:01.940Z","dependency_job_id":"d21a43d1-d6b2-431a-a79a-49708ef5c34e","html_url":"https://github.com/headblockhead/SQUIRREL","commit_stats":null,"previous_names":["headblockhead/pico-keyboard","headblockhead/sqirel","headblockhead/squirrel"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/headblockhead/SQUIRREL","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/headblockhead%2FSQUIRREL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/headblockhead%2FSQUIRREL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/headblockhead%2FSQUIRREL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/headblockhead%2FSQUIRREL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/headblockhead","download_url":"https://codeload.github.com/headblockhead/SQUIRREL/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/headblockhead%2FSQUIRREL/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273067814,"owners_count":25039907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","cmake","keyboard","library"],"created_at":"2024-11-15T02:20:10.883Z","updated_at":"2025-09-01T02:40:58.867Z","avatar_url":"https://github.com/headblockhead.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQUIRREL - Simplified, runtime-configurable QMK as a library\n\u003csup\u003eor: Simplified QMK Uniquely Immaculate (and) Readable Runtime Editable Library\u003c/sup\u003e\n\n🚧 This project is currently **under construction**, so do not expect a usable result yet! 🚧\n\n## Goals:\n- Create an easy to understand and simple keyboard library that allows for runtime layout and configuration edits.\n- Make sure it is as documented and clearly organised as possible.\n- Keep it independent of any microcontroller.\n\nFor an example implementation of SQUIRREL, see the [SQUIRREL-pico](https://github.com/headblockhead/SQUIRREL-pico) example template.\n\n## Development\n\nSQUIRREL uses [nix](https://nixos.org).\n\nTo develop, run the nix shell using `nix develop`. SQUIRREL can also be built using `nix build`.\n\n## Tasks\n\n### Build\nDirectory: ./build\n\nBuilds a static archive library (`.a`).\n\n```bash\ncmake -DCMAKE_BUILD_TYPE=Release ..\nmake -j4\n```\n\n### Build-debug\nDirectory: ./build\n\nBuilds the library with debug build type.\n\n```bash\ncmake -DCMAKE_BUILD_TYPE=Debug .. \nmake -j4\ncp compile_commands.json ../ # Copies the autocomplete information for ccls.\n```\n\n### Test\nDirectory: ./build\n\nTests the library\n\n```bash\ncmake -DCMAKE_BUILD_TYPE=Testing ..\nmake -j4\nctest -T Test -T Coverage --output-on-failure .\n```\n\n### Clean\nCleans the build directory for a fresh build.\n\n```bash\nrm -rf ./build\nmkdir build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheadblockhead%2Fsquirrel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheadblockhead%2Fsquirrel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheadblockhead%2Fsquirrel/lists"}