diff --git a/README.md b/README.md index ae48142..ec5be24 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,17 @@ An alternative TUI-based frontend for the Canvas LMS. Also implements `libcanvas`, a Rust library that wraps common Canvas API actions. + +## Building + +Install Nix with flakes. + +```sh +nix build +``` + +Or run without installing: + +```sh +nix run "git+https://code.youwen.dev/youwen5/cartographer.git" +```