OpenHAB
/
openhab-core
mirror of https://github.com/openhab/openhab-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,601 Commits
10 Branches
124 Tags
67 MiB
Java 98.7%
Xtend 1.1%
Groovy 0.1%
 
 
 
Go to file
Fabian Wolter f79d17f864
[skeleton] Add Thing config table to readme; minor improvements (#2692) 
* [skeleton] Add Thing config table to readme; minor improvements

- put each sentence in a seperate line
- add note that only PNG images are supported. See https://github.com/openhab/openhab-addons/pull/11116#discussion_r775838188
- add examples to "Supported Things"
- add RW column to example Channel table
- add advanced and default config value
- add note that textual config examples are mandatory
- make .sitemap example optional (see small internal discussion)
- put emphasis on initialize() shall return quickly
- add note about logging to INFO
- fix compiler warning
- Add default config value for initialization

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
 		2022-01-22 13:45:37 +01:00
.github Use Maven 3.8.4 in GHA CI builds (#2582) 2021-11-28 20:29:40 +01:00
bom Upgrade to Karaf 4.3.6 (#2689) 2022-01-16 11:55:04 +01:00
bundles [thing] Enable config validation for thing creation and update (#2682) 2022-01-20 10:20:16 +01:00
features Update license headers to 2022 (#2671) 2022-01-07 13:16:42 +01:00
itests [thing] Enable config validation for thing creation and update (#2682) 2022-01-20 10:20:16 +01:00
licenses/epl-2.0 mavenize openHAB and integrate mavenized ESH repository (#467) 2019-01-28 13:07:31 +01:00
tools [skeleton] Add Thing config table to readme; minor improvements (#2692) 2022-01-22 13:45:37 +01:00
.gitattributes Add .gitattributes (#1767) 2020-10-26 22:24:59 +01:00
.gitignore [model] don't require to download antlr generator on build time (#810) 2019-05-14 09:04:35 +02:00
CODEOWNERS Add CODEOWNERS file (#1996) 2020-12-23 20:04:44 +01:00
CONTRIBUTING.md removed 1.x compatibility layer (#1284) 2019-12-21 11:32:29 +01:00
LICENSE Changed license from EPL v1 to EPL v2 (#466) 2019-01-16 22:59:49 +01:00
NOTICE Add NOTICE file (#631) 2019-03-06 16:09:24 +01:00
README.md Added GHA build badge (#2558) 2021-11-04 09:23:09 +01:00
crowdin.yml Fix Crowdin translation filename mismatch (#2302) 2021-04-20 20:26:01 +02:00
pom.xml Upgrade to Karaf 4.3.6 (#2689) 2022-01-16 11:55:04 +01:00

README.md

openHAB Core

GitHub Actions Build Status Jenkins Build Status EPL-2.0 Crowdin Bountysource

This project contains core bundles of the openHAB runtime.

Building and running the project is fairly easy if you follow the steps detailed below.

Please note that openHAB Core is not a product itself, but a framework to build solutions on top. It is picked up by the main openHAB distribution.

This means that what you build is primarily an artifact repository of OSGi bundles that can be used within smart home products.

1. Prerequisites

The build infrastructure is based on Maven. If you know Maven already then there won't be any surprises for you. If you have not worked with Maven yet, just follow the instructions and everything will miraculously work ;-)

What you need before you start:

Make sure that the mvn command is available on your path

2. Checkout

Checkout the source code from GitHub, e.g. by running:

git clone https://github.com/openhab/openhab-core.git

3. Building with Maven

To build this project from the sources, Maven takes care of everything:

  • set MAVEN_OPTS to -Xms512m -Xmx1024m
  • change into the openhab-core directory (cd openhab-core)
  • run mvn clean install to compile and package all sources

If there are tests that are failing occasionally on your local build, run mvn -DskipTests=true clean install instead to skip them.

How to contribute

If you want to become a contributor to the project, please read about contributing and check our guidelines first.