From bfc72f97f401222694f8572f23eb22b1ee5db18d Mon Sep 17 00:00:00 2001 From: Jonathan Yong Date: Wed, 11 Oct 2023 13:23:43 +0100 Subject: [PATCH] Add notes on how to add a new story --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9cea9a93..550a2b4b 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,14 @@ conda env create -f binder/environment.yml Any problems, open an issue! +### Adding a new story + +Under the `stories` directory, create a new folder with the name `YYYY-MM-DD-` and place your notebook inside there. +Make sure you have already run all the cells in your notebook. +That's all! + +If your notebook is not ready to be published to the web, you can prefix the folder with an underscore: Quarto will then ignore it. + ### About the project This project was initially formed by a desire to contribute and advance to the analysis of government COVID-19 data.