Skip to content

Commit d9534a9

Browse files
authored
update build details (#236)
1 parent e3cf801 commit d9534a9

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The documentation is available at
3232

3333
### Prerequisites
3434
- Make sure you have installed a Java Development Kit (JDK) version 8 or later.
35-
- You will need Java Development Kit (JDK) version 11 or later when building the docs.
3635
- Make sure you have [sbt](https://www.scala-sbt.org/) installed.
3736
- [Graphviz](https://graphviz.gitlab.io/download/) is needed for the scaladoc generation build task, which is part of the release.
3837

@@ -43,13 +42,13 @@ The documentation is available at
4342
- `sbt compile` compiles the main source for project default version of Scala (2.13)
4443
- `sbt +compile` will compile for all supported versions of Scala
4544
- `sbt test` will compile the code and run the unit tests
45+
- `sbt testQuick` similar to `test` but when repeated in shell mode will only run failing tests
4646
- `sbt package` will build the jars
4747
- the jars will built into target dirs of the various modules
4848
- for the the 'http-core' module, the jar will be built to `http-core/target/scala-2.13/`
4949
- `sbt publishLocal` will push the jars to your local Apache Ivy repository
5050
- `sbt publishM2` will push the jars to your local Apache Maven repository
5151
- `sbt docs/paradox` will build the docs (the ones describing the module features)
52-
- requires JDK 11 or above
5352
- `sbt docs/paradoxBrowse` does the same but will open the docs in your browser when complete
5453
- the `index.html` file will appear in `target/paradox/site/main/`
5554
- `sbt unidoc` will build the Javadocs for all the modules and load them to one place (may require Graphviz, see Prerequisites above)

0 commit comments

Comments
 (0)