Update README

This commit is contained in:
Fedor A. Fetisov 2017-11-01 05:00:27 +03:00
parent 363c6009f5
commit 75ebb49a5b

View File

@ -1,4 +1,4 @@
# Mibew documentation # Mibew Messenger documentation
This repository contains documentation from https://docs.mibew.org site. This repository contains documentation from https://docs.mibew.org site.
@ -8,13 +8,13 @@ This repository contains documentation from https://docs.mibew.org site.
There are several actions one should perform to build a local copy of 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/). 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 2. Obtain a copy of the repository using `git clone`, download button or in
way. another way.
3. Navigate to the downloaded repository and install npm dependencies by running 3. Navigate to the local copy of the repository and install npm dependencies
`npm install`. by running `npm install`.
4. Build the site by running `node index.js` 4. Build the docs by running `node index.js`
Finally, static documentation site will be placed in `build` directory. Finally, static documentation will be placed in `build` directory.
## License ## License