youwen5/cartographer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add build instructions

Browse source
This commit is contained in:
Youwen Wu 2024-09-11 02:14:34 -07:00
parent 79635cc74e
commit 7e691d07a6
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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"
```