You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2023/05/22 00:38:21 UTC
[incubator-pekko] branch build-instructions created (now 50fe2b9817)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a change to branch build-instructions
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
at 50fe2b9817 Update README.md
This branch includes the following new commits:
new 50fe2b9817 Update README.md
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org
[incubator-pekko] 01/01: Update README.md
Posted by fa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch build-instructions
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
commit 50fe2b9817e7ffc871f5c746e44fec46f6c10941
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Mon May 22 01:38:15 2023 +0100
Update README.md
---
README.md | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e691c027d8..7904f69ca9 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,16 @@ Pekko is a fork of [Akka](https://github.com/akka/akka) 2.6.x, prior to the Akka
Reference Documentation
-----------------------
-**TODO add documentation links**
+See https://pekko.apache.org for the documentation including the API docs.
+
+Building from Source
+--------------------
+
+* You will need to install [sbt](https://www.scala-sbt.org/) if you don't already have it installed
+* 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
+* `sbt test` will build the jars and run the unit tests
+* `sbt docs/paradox` will build the docs
Community
---------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org