diff --git a/README.md b/README.md index aaba2fa1e..b3ed287b0 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,22 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta ### Installation + +1. Copy `.env.example` to `.env` in the project root: + +```bash +cp .env.example .env +``` +2. Install yarn + ``` -$ yarn +yarn ``` ### Local Development ``` -$ yarn start +yarn start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. @@ -19,7 +27,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build ``` -$ yarn build +yarn build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. @@ -29,13 +37,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: ``` -$ USE_SSH=true yarn deploy +USE_SSH=true yarn deploy ``` Not using SSH: ``` -$ GIT_USER= yarn deploy +GIT_USER= yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.