raboof commented on code in PR #337:
URL: https://github.com/apache/incubator-pekko/pull/337#discussion_r1203910400
##########
README.md:
##########
@@ -35,11 +37,10 @@ Building from Source
- Requires Java 11 minimum
- `sbt docs/paradoxBrowse` does the same but will open the docs in your
browser when complete
- the `index.html` file will appear in `target/paradox/site/main/`
-- `sbt unidoc` will build the Javadocs for all the modules and load them to
one place
+- `sbt unidoc` will build the Javadocs for all the modules and load them to
one place (may require Graphvis, see Prerequisites above)
Review Comment:
```suggestion
- `sbt unidoc` will build the Javadocs for all the modules and load them to
one place (may require Graphviz, see Prerequisites above)
```
##########
README.md:
##########
@@ -10,19 +9,22 @@ Using these abstractions, Pekko also provides libraries for
persistence, streams
Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the
Akka project's adoption of the Business Source License.
-Reference Documentation
------------------------
+## Reference Documentation
See https://pekko.apache.org for the documentation including the API docs. The
docs for all the Apache Pekko modules can be found there.
-Building from Source
---------------------
+## Building from Source
+### Prerequisites
- Make sure you have installed a Java Development Kit (JDK) version 11 or
later.
- Make sure you have [sbt](https://www.scala-sbt.org/) installed and using
this JDK.
- Make sure you also have Java 8 installed (JDK or JRE).
-- Use git to clone the [repo](https://github.com/apache/incubator-pekko) or
download a source release from https://pekko.apache.org
-- Open a command window and change directory to the directory where you
installed the source
+- [Graphvis](https://graphviz.gitlab.io/download/) is needed for the scaladoc
generation build task, which is part of the release.
Review Comment:
```suggestion
- [Graphviz](https://graphviz.gitlab.io/download/) is needed for the
scaladoc generation build task, which is part of the release.
```
##########
README.md:
##########
@@ -10,19 +9,22 @@ Using these abstractions, Pekko also provides libraries for
persistence, streams
Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the
Akka project's adoption of the Business Source License.
-Reference Documentation
------------------------
+## Reference Documentation
See https://pekko.apache.org for the documentation including the API docs. The
docs for all the Apache Pekko modules can be found there.
-Building from Source
---------------------
+## Building from Source
+### Prerequisites
- Make sure you have installed a Java Development Kit (JDK) version 11 or
later.
- Make sure you have [sbt](https://www.scala-sbt.org/) installed and using
this JDK.
- Make sure you also have Java 8 installed (JDK or JRE).
-- Use git to clone the [repo](https://github.com/apache/incubator-pekko) or
download a source release from https://pekko.apache.org
-- Open a command window and change directory to the directory where you
installed the source
+- [Graphvis](https://graphviz.gitlab.io/download/) is needed for the scaladoc
generation build task, which is part of the release.
+
+### Running the Build
+- Open a command window and change directory to your preferred base directory
+- Use git to clone the [repo](https://github.com/apache/incubator-pekko) or
download a source release from https://pekko.apache.org (and unzip or untar it,
as appropriate)
Review Comment:
(offtopic: I wonder if we need to do anything special to make sure the
version number is determined correctly when building from a zip/tar)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
