add README

This commit is contained in:
Naxdy 2024-04-16 16:20:36 +02:00
parent 081e661469
commit a3205cb09b
Signed by: Naxdy
GPG key ID: CC15075846BCE91B

7
README.md Normal file
View file

@ -0,0 +1,7 @@
# RustGCC
This repository is a POC of a hitbox-style controller using an RP2040 / Pico that implements the joybus protocol, with firmware written in Rust.
To get started in a ready-to-go development environment, download and install [Nix](https://nixos.org/download.html), then [enable flakes](https://nixos.wiki/wiki/Flakes) and run `nix develop .` in the root of this repository.
To build the firmware, run `nix build .#` in the root of this repository.