Skip to content

Add README for the demo app - #1787

Merged
kaikreuzer merged 2 commits into
openhab:mainfrom
holgerfriedrich:pr-app-doc
Nov 23, 2025
Merged

Add README for the demo app#1787
kaikreuzer merged 2 commits into
openhab:mainfrom
holgerfriedrich:pr-app-doc

Conversation

@holgerfriedrich

Copy link
Copy Markdown
Member

I always forget how to resolve and how to run from mvn... Thus I added a local readme file for the demo app.

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a comprehensive README file for the openHAB demo app to help developers remember how to resolve dependencies and run the application. The documentation provides clear instructions for both IDE and command-line usage, addressing the author's stated need for reference documentation.

  • Adds complete README.md documentation for the demo app
  • Includes startup instructions for both Eclipse IDE and Maven command line
  • Provides troubleshooting guidance for dependency resolution issues

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread launch/app/README.md

If dependencies do not resolve, `launch.bndrun` may need an update.

- Trigger the resolver with:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you use Eclipse it is easier to just click the Resolve button to do this.

See the image in the docs:

https://www.openhab.org/docs/developer/ide/eclipse.html#running-add-ons

@kaikreuzer
kaikreuzer merged commit 704b031 into openhab:main Nov 23, 2025
2 checks passed
@holgerfriedrich
holgerfriedrich deleted the pr-app-doc branch November 23, 2025 22:35
@holgerfriedrich holgerfriedrich added this to the 5.1 milestone Dec 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants