luneski/mqtt-explorer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for how to update http://mqtt-explorer.com

Browse Source
This commit is contained in:
Thomas Nordquist
2020-01-17 12:52:34 +01:00
parent fbad7afa79
commit f63e73ee0a
1 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Readme.md
View File

@@ -46,20 +46,47 @@ To achieve a reliable product automated tests run regularly on travis.
- UI-Tests (The demo is a recorded ui test) - UI-Tests (The demo is a recorded ui test)
## Run UI-tests ## Run UI-tests
A [mosquitto](https://mosquitto.org/) MQTT broker is required to run the ui-tests. A [mosquitto](https://mosquitto.org/) MQTT broker is required to run the ui-tests.
Run tests with Run tests with
```bash ```bash
# Run chromedriver in a separate terminal session # Run chromedriver in a separate terminal session
./node_modules/.bin/chromedriver --url-base=wd/hub --port=9515 --verbose ./node_modules/.bin/chromedriver --url-base=wd/hub --port=9515 --verbose
``` ```
Compile and execute tests Compile and execute tests
```bash ```bash
npm run build npm run build
node dist/src/spec/webdriverio.js node dist/src/spec/webdriverio.js
``` ```
## Write docs
```
git clone https://github.com/thomasnordquist/MQTT-Explorer.git mqtt-explorer-pages
cd mqtt-explorer-pages
git checkout gh-pages
bundle install
bundle exec jekyll serve --incremental
```
Readme file: `Readme.tpl.md`
Preview is available at
http://localhost:4000/Readme.tpl
## Update docs
```
npm install
./updateReadme.ts
```
The readme will be generated from the docs.
## License ## License
![CC-BY-ND 4.0](https://img.shields.io/badge/License-CC%20BY--ND%204.0-blue.svg) ![CC-BY-ND 4.0](https://img.shields.io/badge/License-CC%20BY--ND%204.0-blue.svg)