[GitHub] [incubator-pekko-connectors-kafka] pjfanning commented on a diff in pull request #110: add build docs

["pjfanning (via GitHub)" <gi...@apache.org>]

pjfanning commented on code in PR #110:
URL: https://github.com/apache/incubator-pekko-connectors-kafka/pull/110#discussion_r1271415935


##########
README.md:
##########
@@ -22,6 +22,41 @@ The Apache Pekko Kafka Connector is a fork of [Alpakka Kafka](https://github.com
 
 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
+
+### Prerequisites
+- Make sure you have installed a Java Development Kit (JDK) version 8 or later.
+- Make sure you have [sbt](https://www.scala-sbt.org/) installed and using this JDK.
+- [Graphviz](https://graphviz.gitlab.io/download/) is needed for the scaladoc generation build task, which is part of the release.
+- Having [Docker](https://www.docker.com/) running is required for many of the unit tests.
+
+### 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-connectors-kafka) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)

Review Comment:
   Since the sentence already says `Use git`, I'm not sure it is a good idea to say `git repo`. I think most people would infer thet repo is a git repo. It doesn't read well read to repeat the same word multiple times in a sentence.



-- 
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: notifications-unsubscribe@pekko.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org