cartographer/README.md

34 lines
719 B
Markdown
Raw Normal View History

2024-09-11 02:12:42 -07:00
# Cartographer
An alternative TUI-based frontend for the Canvas LMS. Also implements
`libcanvas`, a Rust library that wraps common Canvas API actions.
2024-09-11 02:14:34 -07:00
## Building
Install Nix with flakes.
```sh
nix build
```
2024-09-12 01:39:53 -07:00
Or run directly:
2024-09-11 02:14:34 -07:00
```sh
nix run "git+https://code.youwen.dev/youwen5/cartographer.git"
```
2024-09-12 01:39:53 -07:00
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`.