docs: add readme

Signed-off-by: Christina Sørensen <ces@fem.gg>
This commit is contained in:
Christina Sørensen 2025-01-27 14:51:27 +01:00
parent 196aeaf6f5
commit b2679944ed
Signed by: cafkafk
GPG key ID: F67767BE4545A600

9
README.md Normal file
View file

@ -0,0 +1,9 @@
# QCODE-Training: a program for learning various Q codes
You can either just clone the repository locally and run the script in `bin` from the root of the repo, or use `nix run` from inside of the repo if you're a nix user.
If you don't even wanna download it:
```bash
nix run git+ssh://meow@git.fem.gg:1337/cafkafk/qcode-drills.git
```