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/07/03 23:02:16 UTC
[incubator-pekko-sbt-paradox] branch main updated: add build instructions to README (#61)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-sbt-paradox.git
The following commit(s) were added to refs/heads/main by this push:
new 57fd82e add build instructions to README (#61)
57fd82e is described below
commit 57fd82eba93a95989fe2e7676c0257d67ddbee9e
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Tue Jul 4 00:02:11 2023 +0100
add build instructions to README (#61)
---
README.md | 36 +++++++++++++++++++++++++++++++++---
1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index b6453dc..9fc6c88 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,6 @@ along with providing the Apache Pekko theme.
It is intended as a shared doc theme for the [Apache Pekko](https://github.com/apache/?q=pekko&type=all&language=&sort=)
umbrella of projects, and not as a public theme to use on "any" project.
-This project is largely based on the original [akka-paradox](https://github.com/akka/akka-paradox) plugin. Credits go
-to the original [contributors](https://github.com/akka/akka-paradox/graphs/contributors) of the project.
-
## Usage
Use the sbt plugin for Pekko Paradox:
@@ -58,3 +55,36 @@ This should show:
Pausing in /tmp/sbt_e457458e/simple
Press enter to continue.
```
+
+## Building from Source
+
+### Prerequisites
+- Make sure you have installed a Java Development Kit (JDK) version 8.
+- Make sure you have [sbt](https://www.scala-sbt.org/) installed and using this JDK.
+
+### 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-sbt-paradox) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)
+- Change directory to the directory where you installed the source (you should have a file called `build.sbt` in this directory)
+- `sbt compile` compiles the main source for project default version of Scala (2.13)
+- `sbt test` will compile the code and run the unit tests
+- `sbt package` will build the jars
+ - the jars will built into target dirs of the various modules
+ - for the the 'plugin' module, the jar will be built to `plugin/target/scala-2.12/sbt-1.0/`
+- `sbt publishLocal` will push the jars to your local Apache Ivy repository
+- `sbt publishM2` will push the jars to your local Apache Maven repository
+- `sbt sourceDistGenerate` will generate source release to `target/dist/`
+- The version number that appears in filenames and docs is derived, by default. The derived version contains the most git commit id or the date/time (if the directory is not under git control).
+ - You can set the version number explicitly when running sbt commands
+ - eg `sbt "set ThisBuild / version := \"1.0.0\"; sourceDistGenerate"`
+ - Or you can add a file called `version.sbt` to the same directory that has the `build.sbt` containing something like
+ - `ThisBuild / version := "1.0.0"`
+
+## Community
+
+There are several ways to interact with the Pekko community:
+
+- [GitHub discussions](https://github.com/apache/incubator-pekko/discussions): for questions and general discussion.
+- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
+- [Pekko users mailing list](https://lists.apache.org/list.html?users@pekko.apache.org): for Pekko user discussions.
+- [GitHub issues](https://github.com/apache/incubator-pekko/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org