cartographer/README.md

908 B

Cartographer

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.

nix build

Or run directly:

nix run "git+https://code.youwen.dev/youwen5/cartographer.git"

You may also be able to compile it manually using cargo but this is not officially supported. Use the latest stable Rust toolchain. You must have openssl and the necessary libraries for Rust to link against.

Hacking

You can enter a development shell with all of the required dependencies (including openssl) with

nix develop

Or use direnv and simply direnv allow.