Skip to content

Fix the build section of the readme for oriel #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adam-waldenberg merged 1 commit into from
Oct 29, 2026
Merged

Fix the build section of the readme for oriel #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,15 @@ mvn clean install

This builds and tests the `core`, `ui` and `shell` modules: the Hedgehog
client, the server-rendered pages and the start of the application. The embedded web
server and the window that hosts it come from Oriel, which has to be installed
into the local Maven repository first, with `mvn install` in its own checkout.
server and the window that hosts it come from [Oriel](https://github.com/unigrid-project/oriel),
which the build fetches from JitPack at the release `oriel.version` names in the root pom.

To build against a checkout of Oriel instead, such as a change that is not released
yet, run `mvn install` in that checkout and name the coordinates it installs as, with
the version from Oriel's own pom:
```
mvn clean install -Doriel.groupId=org.unigrid.oriel -Doriel.version=0.0.2-SNAPSHOT
```

The `desktop` module builds the native installers and is only part of the build
with the `installer` profile. It needs JDK 25 and the platform's packaging tools
Expand Down
Loading