diff --git a/README.md b/README.md index 87df59bbb..9f4e16567 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ +# biopunk.kitchen + +This is the source code behind https://biopunk.kitchen + **to start** -- needs npm install on top level and inside ui directory +- needs [npm](https://www.npmjs.com/get-npm) install on top level + ``` + npm install + ``` +- inside ui directory + ``` + cd ui + npm install + ``` +- install [gatsby](https://www.gatsbyjs.org/docs/) + ``` + npm install -g gatsby-cli + ``` +- run the development version + ``` + gatsby develop + ``` **don't forget to** - adjust repo in cms' config.yml