From a3205cb09b0f6cb92965dc6a294f684b30c481f3 Mon Sep 17 00:00:00 2001 From: Naxdy Date: Tue, 16 Apr 2024 16:20:36 +0200 Subject: [PATCH] add README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b7f1ae --- /dev/null +++ b/README.md @@ -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.