From 302fe3c063cdded16ab7f7c07704d8b2be6ed3b9 Mon Sep 17 00:00:00 2001 From: Jeremy Whiting Date: Tue, 5 Sep 2023 14:16:34 -0600 Subject: [PATCH] Add a basic Hacking.md for getting started, building, running, etc. --- Hacking.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 Hacking.md diff --git a/Hacking.md b/Hacking.md new file mode 100644 index 0000000..4b4776e --- /dev/null +++ b/Hacking.md @@ -0,0 +1,26 @@ +This project is written in rust. For any unfamiliar with how that works the following should help: + +To build you'll want a rust implementation for your laptop/device you are testing on. + +https://wiki.archlinux.org/title/rust has some good guidelines for getting that sorted. but mostly boils down +to install rustup from the rustup package (if you're on arch) and use: + +rustup default stable + +to get an initial toolchain, etc. + +Once you have that and cargo is in your path, to build and run this project use the following: + +To build: + +cargo build + +To run: + +cargo run + +As far as IDEs go I find Visual Studio Code works pretty well for giving errors about things you +are changing and has plugins for vim mode, etc. if you are used to those keybindings. Most/all +IDEs that work with language servers should do that fine though. + +For VS Code I use these extensions to help: rust and rust-analyzer