Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lselker13 authored Mar 24, 2023
1 parent 848d13c commit 66227c5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# cider-documentation

This repository contains the source files for the documentation for the Cider software package. The docs are exposed [here](https://global-policy-lab.github.io/cider-documentation/intro.html). The Cider repository is [here](https://github.com/Global-Policy-Lab/cider).

To update this documentation:
* Make changes to source
* Build the changes using jupyter-book
* Copy the contents of _build/html into docs. You can check you did this right by confirming that docs/index.html exists
* Propagate the changes to the remote gh-pages branch on Github

0 comments on commit 66227c5

Please sign in to comment.