Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemtjanst/protokoll
Protocol specification
https://github.com/hemtjanst/protokoll
domotic home-automation smarthome
Last synced: about 1 month ago
JSON representation
Protocol specification
- Host: GitHub
- URL: https://github.com/hemtjanst/protokoll
- Owner: hemtjanst
- Created: 2019-05-11T15:00:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T02:43:58.000Z (almost 2 years ago)
- Last Synced: 2023-02-27T04:55:42.716Z (almost 2 years ago)
- Topics: domotic, home-automation, smarthome
- Language: Ruby
- Homepage: https://hemtjan.st/protokoll
- Size: 51.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Protokoll [![Build Status](https://travis-ci.org/hemtjanst/protokoll.svg?branch=master)](https://travis-ci.org/hemtjanst/protokoll)
Hemtjänst documentation.
View it at [hemtjan.st/protokoll](https://hemtjan.st/protokoll).
Powered by:
* [Jekyll](https://jekyllrb.com/)
* [Just The Docs](https://pmarsceill.github.io/just-the-docs/)## Development
In order to run the site locally, you'll need Ruby and Bundler:
```sh
$ bundle install
$ bundle exec jekyll serve -w --config _config.yml,_config-dev.yml
Configuration file: _config.yml
Configuration file: _config-dev.yml
Source: github.com/hemtjanst/protokoll
Destination: github.com/hemtjanst/protokoll/_site
Incremental build: disabled. Enable with --incremental
Generating...
done in 2.354 seconds.
Auto-regeneration: enabled for 'github.com/hemtjanst/protokoll'
Server address: http://127.0.0.1:4000/
Server running... press ctrl-c to stop.
```A number of Rake tasks are provided:
```sh
$ bundle exec rake -vT
rake build # Build the site with Jekyll
rake clean # Remove generated site
rake doctor # Check for Jekyll deprecation issues
rake test # Build and validate the site
rake validate # Validate _site/ with html-proofer
```CI will run `rake test` on PRs.