From cdddd1937e977911290850972f8903ddd5b3d4e2 Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Thu, 12 Sep 2024 14:20:05 -0700 Subject: [PATCH] docs: update readme to mention scope --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b0a84a..e5af0dc 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ An alternative TUI-based frontend for the Canvas LMS. Also implements `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 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 (including `openssl`) with -```bash +```sh nix develop ```