Merge pull request #1 from spestana/main

Update README with more instructions

README.md

@@ -5,12 +5,60 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/simple-template/HEAD?labpath=book%2Fchapters)
 [![GeoSMART Use Case](./book/img/use_case_badge.svg)](https://geo-smart.github.io/usecases)
 
-This repository stores a skeleton of a GeoSMART use case book.<br>
+## How to use this template
 
-1. Click "Use This Template" and name your repository
+This repository is a template for creating a GeoSMART use case book. These use the Jupyter Book format, documentation for which can be found [here](https://jupyterbook.org/en/stable/intro.html). Jupyter Book websites are built using Jupyter Notebook (`.ipynb`) and markdown (`.md`) files.
 
-2. In your repository edit book/_config.yml
+### Create a new repository from this template
+1. On the top right of the page, click *Use this template* and then *Create a new repository*
+2. This should take you to a new page titled *Create a new repository*
+3. Double check that the dropdown menu below *Repository template* says either *geo-smart/simple-template* or *geo-smart/use_case_template*
+4. Leave the box unchecked for *Include all branches*
+5. For *Owner* select your github user account, or another organization to create the new repository under
+6. Give your use case repository a name under *Repository name*
+7. Add a short *Description*
+8. Select the option for *Public*
+9. Finally, click *Create repository*
 
-3. Under your repository Settings --> Pages --> Source = GitHub Actions
+### Configure your new use case repository
+
+With your new use case repository, you can choose to clone the repository to work on your local system, or edit configuration files within the web browser.
+
+In the `book` directory, update the `_config.yml` file with some basic information:
+- `title: `
+- `author: `
+- `repository:` `url: `
+
+You can leave all the other configuration options unchanged for now.
+
+### Setup GitHub Action to build the JupyterBook
+
+In your repository *Settings* (gear icon on top of your repository's page), go to the *Pages* section.
+
+Under the *Build and deployment* settings, click on the dropdown menu below *Source* and select *GitHub Actions*.
+
+Your JupyterBook is now configured to build and deploy following each new commit you make to the repository. Note: The file that runs the build and deploy action is located at `/.github/workflows/publish.yml` but **you do not need to make any changes to this file**.
+
+If a commit fails to produce a new version of the Book, go to the *Actions* tab on the GitHub repository page to read the action logs and diagnose errors (failed actions will have a red icon with an X next to them).
+
+### Add your use case content
+
+Now that you have completed the creation, configuration, and setup steps, you can begin adding your use case content to the JupyterBook. 
+
+* update the `environment.yml` file to include any packages that your use case code will require (the Jupyter Notebooks are executed with this environment each time the GitHub action that builds and deploys the website is ran).
+* `book/intro.md` is where you can add content for your Jupyter Book's home page
+* `book/chapters/` will contain markdown or Jupyter Notebook files, the main content of your use case Jupyter Book
+    * This template contains placeholder Jupyter Notebook files to illustrate a recommended way to organize your content. You can edit each of these files to add your content following the suggested organization, or remove and replace the placeholder files with your own content.
+* Update the table of contents file (`/book/_toc.yml`) to organize page navigation through the website
+  * Jupyter Books organize content by *Parts*, and within each part are *Chapters*. A chapter consists of a single Jupyter Notebook or markdown file.
+  * You create and title parts in the table of contents file with `- caption: Part Title`
+  * Under each part you can list one or more chapters using `- file: chapters/my_file` which points to either `my_file.ipynb` or `my_file.md`
+
+## Other resources
+
+We recommend that you refer to the JupyterBook documentation on the following topics to help your organize your content:
+* [Structure](https://jupyterbook.org/en/stable/structure/toc.html) and [Configure](https://jupyterbook.org/en/stable/structure/configure.html) the table of contents, `book/_toc.yml`
+* [Markdown](https://jupyterbook.org/en/stable/file-types/markdown.html) and [Jupyter Notebook](https://jupyterbook.org/en/stable/file-types/notebooks.html) files for the content in `book/chapters/`
+* Embeding [images and figures](https://jupyterbook.org/en/stable/content/figures.html) from `book/img/`, and writing inline [math and equations](https://jupyterbook.org/en/stable/content/math.html)
+* [Links and references](https://jupyterbook.org/en/stable/content/references.html), [special content blocks](https://jupyterbook.org/en/stable/content/content-blocks.html), and more ways to [structure chunks of content](https://jupyterbook.org/en/stable/content/components.html)
 
-3. Edit environment.yml, modify notebooks, and your JupyterBook will be published for you!