From a3b36c15897070ff6ce3ed88e29ac71f3c1bae21 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 2 Jul 2018 23:03:06 +0200 Subject: [PATCH] Make needed command better visible (#48) --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 27b05005..fc8290c0 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,18 @@ Documentation is build using [Docusaurus](https://docusaurus.io/docs/en/doc-mark ### Preparing environment -Running the documentation locally requires [NodeJS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) to be installed. Inside a cloned fork of this repository, run `script/setup`. +Running the documentation locally requires [NodeJS](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/) to be installed. Inside a cloned fork of this repository, run: + +```bash +$ script/setup +``` + +This will install [docusaurus](https://www.npmjs.com/package/docusaurus) amongst other things. ### Running docs locally ```bash -script/server +$ script/server ``` It will start a server at [localhost:3000](http://localhost:3000).