mirror of
https://github.com/Mibew/docs.mibew.org.git
synced 2025-05-01 22:56:41 +03:00
Update README
This commit is contained in:
parent
363c6009f5
commit
75ebb49a5b
14
README.md
14
README.md
@ -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
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user