From 4cedb9e73c1f3ff2883532db4965616ee8b6b139 Mon Sep 17 00:00:00 2001 From: Dmitriy Simushev Date: Wed, 15 Apr 2015 10:41:52 +0000 Subject: [PATCH] Add instructions about docs building --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0292fc2..d97b3b8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # Mibew documentation -This repository contains documentation from docs.mibew.org site. +This repository contains documentation from https://docs.mibew.org site. + + +## Building the docs + +There are several actions one should perform to build a local copy of the docs: +1. Install [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/). +2. Obtain a copy of the repository using `git clone`, download button or another + way. +3. Navigate to the downloaded repository and install npm dependencies by running + `npm install`. +4. Build the site by running `node index.js` + +Finally, static documentation site will be placed in `build` directory.