32 lines
719 B
Markdown
32 lines
719 B
Markdown
# Cartographer
|
|
|
|
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 directly:
|
|
|
|
```sh
|
|
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
|
|
|
|
```bash
|
|
nix develop
|
|
```
|
|
|
|
Or use [direnv](https://direnv.net/) and simply `direnv allow`.
|