Kai Kreuzer
parent
56380e8361
commit
e0ee60f225
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
layout: intro
|
||||
---
|
||||
|
||||
{% include base.html %}
|
||||
|
||||
<div class="container target">
|
||||
<h1>Welcome to the openHAB 2 Documentation!</h1>
|
||||
<p>This documentation contains different sections. If you are new to openHAB 2, you might want to start with one of our <a href="tutorials">Tutorials</a> that guides you through different steps by an example. If you are looking for some specific information on how to use openHAB, the <a href="overview.html">User Manual</a> is the right place to go and if you plan to get started with your own developments, please refer to our <a href="developers">Developer Guide</a>.</p>
|
||||
<p><strong>Note:</strong> This documentation is currently heavily worked on, so expect regular changes. If you feel that something important is missing, please <a href="https://github.com/openhab/openhab-docs/blob/gh-pages/README.md#contributing-to-the-documentation">help us improving the documentation</a>!
|
||||
<div class="row center targets">
|
||||
<div class="col s12 m4 l4">
|
||||
<a href="tutorials">
|
||||
<div class="target target-beginner card">
|
||||
<i class="mdi-action-explore icon-large"></i>
|
||||
<div class="footer">
|
||||
<div class="valign-wrapper">
|
||||
<h2 class="valign">Tutorials</h2>
|
||||
</div>
|
||||
</div>
|
||||
</div></a>
|
||||
</div>
|
||||
|
||||
<div class="col s12 m4 l4">
|
||||
<a href="overview.html">
|
||||
<div class="target target-advanced card">
|
||||
<i class="mdi-file-folder-shared icon-large"></i>
|
||||
<div class="footer">
|
||||
<div class="valign-wrapper">
|
||||
<h2 class="valign">User Manual</h2></div>
|
||||
</div>
|
||||
</div></a>
|
||||
</div>
|
||||
<div class="col s12 m4 l4">
|
||||
<a href="developers">
|
||||
<div class="target target-migration card">
|
||||
<i class="mdi-device-developer-mode icon-large"></i>
|
||||
<div class="footer">
|
||||
<div class="valign-wrapper">
|
||||
<h2 class="valign">Developer Guide</h2></div>
|
||||
</div>
|
||||
</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
24
index.md
24
index.md
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
layout: intro
|
||||
---
|
||||
|
||||
{% include base.html %}
|
||||
|
||||
# Introduction to openHAB 2
|
||||
|
||||
openHAB is software for integrating different home automation systems and technologies into one single solution that allows over-arching automation rules, and that offers uniform user interfaces.
|
||||
|
||||
openHAB 2 is the successor to [openHAB 1](https://github.com/openhab/openhab/wiki). It is an open-source solution based on the [Eclipse SmartHome](https://eclipse.org/smarthome/) framework. It is fully written in Java and uses [Apache Karaf](http://karaf.apache.org/) together with [Eclipse Equinox](https://www.eclipse.org/equinox/) as an OSGi runtime, and bundles this with [Jetty](https://www.eclipse.org/jetty/) as an HTTP server.
|
||||
|
||||
openHAB is highly modular software, which means that the base installation (the "runtime") can be extended through "add-ons". The openHAB distribution includes add-ons from different sources and makes them all available.
|
||||
|
||||
|
||||
|
||||
Note that the openHAB distribution repository does not contain any source code, but it rather aggregates features from different repositories:
|
||||
|
||||
- [Eclipse SmartHome Framework](https://github.com/eclipse/smarthome): This repository holds the major parts of the core functionality.
|
||||
- [openHAB 2 Core](https://github.com/kaikreuzer/openhab-core): This repository contains a few small bundles that are not part of Eclipse SmartHome, but are required for the openHAB runtime. This e.g. contains a compatibility layer for supporting openHAB 1 add-ons.
|
||||
- [openHAB 2 Add-ons](https://github.com/openhab/openhab2): Add-ons of openHAB that use the Eclipse SmartHome APIs can be found within this repository. They cannot be used with an openHAB 1.x runtime, since they provide features that the old runtime does not support.
|
||||
- [openHAB 1 Add-ons](https://github.com/openhab/openhab): Add-ons developed for openHAB 1.x. Most of them are working smoothly on the openHAB 2 runtime and thus they are packaged within the distribution.
|
||||
- [Eclipse SmartHome Extensions](https://github.com/eclipse/smarthome/tree/master/extensions): Since openHAB uses the Eclipse SmartHome framework, it is automatically compatible with all extensions that are available for it and maintained within the Eclipse SmartHome repository. These are usually high-quality extensions that might be even used in commercial products.
|
||||
|
||||
|
|
@ -39,7 +39,3 @@ If you have questions about the use of openHAB, before reporting an issue, or fo
|
|||
|
||||
Rules about posting an issue and [contributions guidelines](appendix/contributing.html) are in the _Appendix_.
|
||||
|
||||
# Developer Documentation
|
||||
|
||||
The [_Developer Guide_](/developers) contains practical and technical information for people willing to contribute to the development of openHAB or of one of its add-ons.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue