jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 08:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make needed command better visible (#48)

Browse Source
This commit is contained in:
Fabian Affolter 2018-07-02 23:03:06 +02:00 committed by GitHub
parent 95cf82f53b
commit a3b36c1589
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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).