diff --git a/README.md b/README.md index ce1aa70bdc28d9403a709ccd0bfa1379a2903265..be3f3b866e5a966523c8fa8f54b086a1ae181049 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ -[](/../pipelines) -[](/../pipelines) - # ERASER - OpenLicht Knowledge Base ## Overview -There are a few subprojects in this repository: +There are the following subprojects in this repository: - Base - - **eraser-base**: The core part of the framework containing the [grammar](/../blob/master/eraser-base/src/main/jastadd/main.relast), various attributes, the [parser](/../blob/master/eraser-base/src/main/jastadd/eraser.parser) for model specification files, and Java classes for the [openHAB communication](/../tree/master/eraser-base/src/main/java/de/tudresden/inf/st/eraser/openhab2) via [MQTT](/../blob/master/eraser-base/src/main/java/de/tudresden/inf/st/eraser/openhab2/mqtt/MQTTUpdater.java) + - **eraser-base**: The core part of the framework containing the [grammar](/../../blob/master/eraser-base/src/main/jastadd/main.relast), various attributes, the [parser](/../../blob/master/eraser-base/src/main/jastadd/eraser.parser) for model specification files, and Java classes for the [openHAB communication](/../../tree/master/eraser-base/src/main/java/de/tudresden/inf/st/eraser/openhab2) via [MQTT](/../../blob/master/eraser-base/src/main/java/de/tudresden/inf/st/eraser/openhab2/mqtt/MQTTUpdater.java) - Utility - **commons.color**: Utilities for converting color spaces (XYZ, RGB, HSB) + - **eraser.rest** and **eraser.spark**: REST-API to communicate with the framework + - **eraser.starter**: The main entry point to start the application + - **feedbackloop.\***: Component specification and implementation of the MAPE-K feedback loop - **project-template**: Template to quickly create new subprojects used by `make-new-project.py` - Demos - **integration** and **openhab-mock**: Playground projects testing some features - **skywriter-hue-integration**: The first real demonstrator integrating the [Skywriter gesture recogintion](http://docs.pimoroni.com/skywriter) with a [Hue](http://www.meethue.com/) using a simple rule -- Machine Learning Integration - - **org.openhab.action.machinelearn**: openHAB connector of the Machine Learning Part (implemented by Kay) - - **org.openlicht.action.reinforcementlearning**: Reinforcement-Learning of preferences (implemented by Kay) - - **stub.org.openhab.core.scriptengine.action**: Stub to make the other two projects build + - **benchmark**: Small benchmark to replay previously recoreded sensor events +- Machine Learning Integration (deprecated) + - org.openhab.action.machinelearn: openHAB connector of the Machine Learning Part + - org.openlicht.action.reinforcementlearning: Reinforcement-Learning of preferences + - stub.org.openhab.core.scriptengine.action: Stub to make the other two projects build ## Setup and Building -This project uses Gradle as the build tool. For detailed information, see [setup guidelines](/../wikis/setup) +This project uses Gradle as the build tool. For detailed information, see [setup guidelines](/../../wikis/setup) ## Running the demo