From c100d0faefeae2eda84161bc2ba3c839b60d4fd0 Mon Sep 17 00:00:00 2001 From: Chandrasekhar Ramakrishnan <cramakri@ethz.ch> Date: Wed, 11 Mar 2020 21:46:17 +0000 Subject: [PATCH] docs: include project-specific information in README.md --- README.md | 37 ++++++++----------------------------- 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index a135e86b..6162ee1b 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,15 @@ # covid-19-dashboard -This is a Renku project - basically a git repository with some -bells and whistles. You'll find we have already created some -useful things like `data` and `notebooks` directories and -a `Dockerfile`. +A Renku project for exploring Covid-19 data sources. -## Working with the project +# Data Sources -The simplest way to start your project is right from the Renku -platform - just click on the `Environments` tab and start a new session. -This will start an interactive environment right in your browser. +## Covid-19 -To work with the project anywhere outside the Renku platform, -click the `Settings` tab where you will find the -git repo URLs - use `git` to clone the project on whichever machine you want. +- https://github.com/CSSEGISandData/COVID-19 +- https://github.com/COVID19Tracking/covid-19-crawler +- https://github.com/openZH/covid_19 -### Changing interactive environment dependencies +## General -Initially we install a very minimal set of packages to keep the images small. -However, you can add python and conda packages in `requirements.txt` and -`environment.yml` to your heart's content. If you need more fine-grained -control over your environment, please see [the documentation](https://renku.readthedocs.io/en/latest/user/advanced_interfaces.html#dockerfile-modifications). - -## Project configuration - -Project options can be found in `.renku/renku.ini`. In this -project there is currently only one option, which specifies -the default type of environment to open, in this case `/lab` for -JupyterLab. You may also choose `/tree` to get to the "classic" Jupyter -interface. - -## Moving forward - -Once you feel at home with your project, we recommend that you replace -this README file with your own project documentation! Happy data wrangling! +- https://data.worldbank.org/indicator/SP.POP.TOTL -- GitLab