From 3e85ae3b603c066db6d83e9a8974ad42dc42c85b Mon Sep 17 00:00:00 2001
From: Eric Eastwood <contact@ericeastwood.com>
Date: Wed, 15 Jun 2022 01:21:10 -0500
Subject: [PATCH] Easy get the app running steps (#21)

Easy get the app running steps:

 1. Install
 2. Edit the config to point at your homeserver
 3. Run the app!

---

This is made possible thanks to the change we made in https://github.com/matrix-org/matrix-public-archive/pull/20#discussion_r897567619 to start using a scoped custom version of `hydrogen-view-sdk`. This includes all of the scratch changes necessary to get this project running which makes the `npm install` just work out of the box without all of the `npm link` hassle.
---
 README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 6c79e93..c074033 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,18 @@ the maintenance burden of supporting more event types in Hydrogen.
 
 ### Get the app running
 
+```sh
+$ npm install
+
+# Edit config/config.user-overrides.json so that `matrixServerUrl` points to your homeserver
+# and has `matrixAccessToken` defined
+$ cp config/config.default.json config/config.user-overrides.json
+
+$ npm run start-dev
+```
+
+## Development
+
 ```sh
 # We need to use a draft branch of Hydrogen to get the custom changes needed for
 # `matrix-public-archive` to run. Hopefully soon, we can get all of the custom
@@ -52,15 +64,16 @@ $ git clone git@github.com:matrix-org/matrix-public-archive.git
 $ cd matrix-public-archive
 $ npm install
 $ npm link hydrogen-view-sdk
-# If you just want to run the tests,you can skip to the "Running tests" section at this point
+# If you just want to run the tests, you can skip to the "Running tests" section at this point
+#
+# Edit config/config.user-overrides.json so that `matrixServerUrl` points to your homeserver
+# and has `matrixAccessToken` defined
 $ cp config/config.default.json config/config.user-overrides.json
-# Edit config/config.user-overrides.json so that it points to your homeserver
-# and has an access token
 
 # Now we can finally start the app
-$ npm start-dev
+$ npm run start-dev
 ```
 
-## Running tests
+### Running tests
 
 See the [testing readme](./test/README.md).