docs: improve "Quick Start" documentation in top-level and sir exampl…

…e READMEs (#561) Fixes #564 Co-authored-by: Chris Campbell <[email protected]>
climateinteractive · Nov 21, 2024 · b20655a · b20655a
1 parent 4b37db0
commit b20655a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -128,7 +128,13 @@ pnpm create @sdeverywhere@latest
 yarn create @sdeverywhere
 ```
 
-Answer a few questions, and within minutes you can have a functional web application that runs your model!
+The `create` script will ask you a few questions.
+The default answers have been chosen to get you up and running quickly.
+If at any step you are unsure of the best option, simply hit the "enter" key to select the default answer.
+You can always change the configuration for your project after it has been created by editing the `sde.config.js` file and the other files in the `config` directory.
+
+After answering all questions, you will have a functional web application that runs your model!
+For more guidance on configuring your project, refer to [Creating a Web Application](https://github.com/climateinteractive/SDEverywhere/wiki/Creating-a-Web-Application) in the [SDEverywhere wiki](https://github.com/climateinteractive/SDEverywhere/wiki).
 
 ## Documentation
 

diff --git a/examples/sir/README.md b/examples/sir/README.md
@@ -24,7 +24,8 @@ cd ./sir
 
 # Create a new project (you can also use yarn or pnpm here, if preferred).
 # Be sure to choose the "Default" template, which will make use of the
-# existing files in the `config` directory.
+# existing files in the `sir/config` directory that have been
+# pre-configured with some graphs and sliders.
 npm create @sdeverywhere@latest
 
 # Enter development mode for the sample model.  This will start a live