Skip to content

Commit

Permalink
README: Move local dependency note above build step and add command line
Browse files Browse the repository at this point in the history
Make it easier for people unfamiliar with the system.
  • Loading branch information
CristianPrundeanu authored and luben committed Jan 18, 2024
1 parent c776e15 commit 20014d1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ The build system depends on Scala and the tests depend on ScalaTest and
ScalaCheck but the produced JAR does not have any dependencies. It also
embeds the native library.

*Note*: For the moment the project depends on a local build of `sbt-java-module-info`
v0.5.2, as that version is not published to Maven. Before compiling, you need to publish it locally:
```
$ cd sbt-java-module-info && ./sbt publishLocal && cd -
```

Compile and test:
```
$ ./sbt compile test package
Expand All @@ -72,9 +78,6 @@ If you want to publish it to you local ivy2 repository:
$ ./sbt publishLocal
```

*Note*: for the moment the project depends on local build of `sbt-java-module-info`
v0.5.2 as that version is not publushed to Maven.

Binary releases
---------------

Expand Down

0 comments on commit 20014d1

Please sign in to comment.