demus/openhab-core
1
0
Fork 0
mirror of https://github.com/danieldemus/openhab-core.git synced 2026-07-29 12:34:22 +02:00
Code Issues 1 Packages Projects Releases Wiki Activity

Update README.md (#1288)

Browse Source 
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
This commit is contained in:
Christoph Weitkamp
2019-12-21 18:43:16 +01:00
committed by Wouter Born
parent be89210019
commit acbede5d75
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -8
View File
@@ -1,15 +1,15 @@
# openHAB 2 Core # openHAB Core
[![Build Status](https://travis-ci.org/openhab/openhab-core.svg)](https://travis-ci.org/openhab/openhab-core) [![Build Status](https://travis-ci.org/openhab/openhab-core.svg)](https://travis-ci.org/openhab/openhab-core)
[![EPL-2.0](https://img.shields.io/badge/license-EPL%202-green.svg)](https://opensource.org/licenses/EPL-2.0) [![EPL-2.0](https://img.shields.io/badge/license-EPL%202-green.svg)](https://opensource.org/licenses/EPL-2.0)
[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=28054058)](https://www.bountysource.com/teams/openhab/issues?tracker_ids=28054058) [![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=28054058)](https://www.bountysource.com/teams/openhab/issues?tracker_ids=28054058)
This project contains core bundles of the openHAB 2 runtime. This project contains core bundles of the openHAB runtime.
Building and running the project is fairly easy if you follow the steps detailed below. Building and running the project is fairly easy if you follow the steps detailed below.
Please note that openHAB 2 Core is not a product itself, but a framework to build solutions on top. 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 build](https://github.com/openhab/openhab-distro). It is picked up by the main [openHAB distribution](https://github.com/openhab/openhab-distro).
This means that what you build is primarily an artifact repository of OSGi bundles that can be used within smart home products. This means that what you build is primarily an artifact repository of OSGi bundles that can be used within smart home products.
@@ -23,21 +23,23 @@ What you need before you start:
- Maven 3 from https://maven.apache.org/download.html - Maven 3 from https://maven.apache.org/download.html
Make sure that the "mvn" command is available on your path Make sure that the `mvn` command is available on your path
## 2. Checkout ## 2. Checkout
Checkout the source code from GitHub, e.g. by running: Checkout the source code from GitHub, e.g. by running:
```
git clone https://github.com/openhab/openhab-core.git git clone https://github.com/openhab/openhab-core.git
```
## 3. Building with Maven ## 3. Building with Maven
To build this project from the sources, Maven takes care of everything: To build this project from the sources, Maven takes care of everything:
- set MAVEN_OPTS to "-Xms512m -Xmx1024m" - set `MAVEN_OPTS` to `-Xms512m -Xmx1024m`
- change into the openhab-core directory ("cd openhab-core“) - change into the openhab-core directory (`cd openhab-core`)
- run "mvn clean install" to compile and package all sources - 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. If there are tests that are failing occasionally on your local build, run `mvn -DskipTests=true clean install` instead to skip them.