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

docs: update readme to mention scope

Browse source
This commit is contained in:
Youwen Wu 2024-09-12 14:20:05 -07:00
parent c5d5c293a2
commit cdddd1937e
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -3,6 +3,10 @@
An alternative TUI-based frontend for the Canvas LMS. Also implements An alternative TUI-based frontend for the Canvas LMS. Also implements
`libcanvas`, a Rust library that wraps common Canvas API actions. `libcanvas`, a Rust library that wraps common Canvas API actions.
It is built for use by students/enrollees in courses, not instructors. There
are no plans to support features specifically for instructors, but feel free to
open a pull request to add them.
## Building ## Building
Install Nix with flakes. Install Nix with flakes.
@ -26,7 +30,7 @@ officially supported. Use the latest stable Rust toolchain. You must have
You can enter a development shell with all of the required dependencies You can enter a development shell with all of the required dependencies
(including `openssl`) with (including `openssl`) with
```bash ```sh
nix develop nix develop
``` ```