1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50a4781
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Building
+
+Rust nightly is required due to the rocket dependency. Other dependencies
+are listed in `shell.nix`.
+
+If using rustup, use `rustup override nightly` to use the nightly toolchain in
+this directory.
+
+Build using `cargo build`.
+
+# Initial Setup
+
+Some configuration needs to be populated in the database using the `init`
+command.
+
+```bash
+# A postgresql url, e.g., for my_database over a default local socket:
+DB_URL=postgres://my_user@/my_database
+
+# Key used by rocket.rs to encrypt client-side login tokens.
+ROCKET_SECRET_KEY=openssl rand -base64 32
+
+cargo run -- --database_url $DB_URL \
+  init --rocket_secret_key $ROCKET_SECRET_KEY \
+  --strava_client_id <client id from strava>
+  --strava_client_secret <client secret from strava>
+```