cfw

About

cutefirmware (cfw) is custom computer keyboard firmware using FreeRTOS™.

This project adheres to Semantic Versioning. For detailed version history, see CHANGELOG.md.

Installing

To install the development environment, clone this repository recursively;

git clone --recursive git@github.com:Cutie-Club/cfw-core.git

If you already have a clone of this repository, you can use git submodule update --init --recursive to download the submodules.

Building

cfw uses a CMake build system. To build, enter the build directory and enter the following command;

cmake --build .

This will build the project and create a .hex file.

To build and flash, specify the upload target.

cmake --build . --target upload

Make sure your MCU has been reset and is ready for flashing.

Contributing

cfw is in the early stages of development; we welcome contributions of any nature as end users should assume any part of this software may change and or break at any time. Please do not submit configurations or layouts for specific keyboards to this library at this time - a separate keyboards repository that submodules cfw-core will be created for these.

Licence

This software is licenced under the GNU General Public Licence v3.0, or any later version.

SPDX-License-Identifier: (GPL-3.0-or-later) Copyright (C) 2021 Cutie Club