aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index ab5eaa8..2bc3611 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,16 @@ Soon is a minimalist, text file based, CLI calendar inspired by [When](https://w
In terms of features and complexity, Soon lies between [When](https://www.lightandmatter.com/when/when.html) and [Remind](https://dianne.skoll.ca/projects/remind/) but aims to be less verbose than either.
+# Build
+
+Install [Nim](https://nim-lang.org/install_unix.html), then
+
+```
+git clone https://codeberg.org/historia/soon
+nimble build
+./soon
+```
+
# Quick Start
1. Run `soon -e` to edit your default calendar. On first run, soon will generate a config and calendar file under $XDG_CONFIG_HOME/soon.