From e78a83aec762149dcbdeb474eb2ca23610dc1130 Mon Sep 17 00:00:00 2001
From: Michael Zhang <mail@mzhang.io>
Date: Mon, 8 Mar 2021 18:32:01 -0600
Subject: [PATCH] add docs

---
 docs/src/config.md |  3 ++-
 docs/src/intro.md  | 14 ++++++++++++++
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/docs/src/config.md b/docs/src/config.md
index 04404e4..1b587e4 100644
--- a/docs/src/config.md
+++ b/docs/src/config.md
@@ -1,6 +1,7 @@
 # Config
 
-Configuration is done by editing `$XDG_CONFIG_HOME/panorama/panorama.toml`. It
+Configuration is done by editing `$XDG_CONFIG_HOME/panorama/panorama.toml`.
+This is usually found somewhere like `$HOME/.config/panorama/panorama.toml` It
 follows the [TOML][1] file format, and the data structures are defined in code
 at `src/config.rs`.
 
diff --git a/docs/src/intro.md b/docs/src/intro.md
index 84649da..76a1cea 100644
--- a/docs/src/intro.md
+++ b/docs/src/intro.md
@@ -4,4 +4,18 @@ Panorama is a personal information manager.
 
 [Click here for API docs][1]
 
+## Quick Start
+
+Since panorama is still in active development, install from git master with
+
+```
+cargo install panorama --git https://github.com/iptq/panorama
+```
+
+Then, create a config file. The format along with examples can be found in
+[this page of the manual][2].
+
+That's it! Run `panorama` forever.
+
 [1]: https://pim.mzhang.io/api/panorama/
+[2]: ./config.md