From 7e691d07a6e53bb0c21525757733bc9894e15095 Mon Sep 17 00:00:00 2001
From: Youwen Wu <youwenw@gmail.com>
Date: Wed, 11 Sep 2024 02:14:34 -0700
Subject: [PATCH] docs: add build instructions

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index ae48142..ec5be24 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,17 @@
 
 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 without installing:
+
+```sh
+nix run "git+https://code.youwen.dev/youwen5/cartographer.git"
+```