From 62ffbcf20c14d721734cc0e1699875ee9a9c38ef Mon Sep 17 00:00:00 2001 From: Nepomuk Seiler Date: Wed, 1 Oct 2014 11:25:31 +0200 Subject: [PATCH] Preparing documentation for next release --- README.md | 4 +-- src/sphinx/DetailedTopics/archetypes.rst | 30 ++++++++++++++++++- .../MyFirstProject.rst | 2 +- src/sphinx/installation.rst | 4 +-- 4 files changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f214a5792..e52427ca5 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ Add the following to your `project/plugins.sbt` file: ```scala // for sbt 0.12.x and scala 2.9.x -addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5-RC2") +addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5") // for sbt 0.13.x and scala 2.10.x -addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M1") +addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2") ``` For the native packager keys add this to your `build.sbt` diff --git a/src/sphinx/DetailedTopics/archetypes.rst b/src/sphinx/DetailedTopics/archetypes.rst index 075a12528..7d568eeeb 100644 --- a/src/sphinx/DetailedTopics/archetypes.rst +++ b/src/sphinx/DetailedTopics/archetypes.rst @@ -126,7 +126,29 @@ to your packaging for Debian. *Note:* All specified users are **deleted** on an Akka Microkernel Application ---------------------------- -Akka microkerneal application is simlar to a Java Command Line application. Instead to run the ``mainClass``, akka microkernel application need run java with main class ``akka.kernel.Main``. The bash/bat script that starts up a Akka application is copied from Akka distribution. To use this archetype in your build, do the following in your ``build.sbt``: +An Akka microkernel application is simlar to a Java Command Line application. Instead of running the classic ``mainClass``, +an Akka microkernel application instantiates and runs a subclass of +`Bootable `_ . A minimal example +could look like this + +.. code-block:: scala + + class HelloKernel extends Bootable { + val system = ActorSystem("hellokernel") + + def startup = { + // HelloActor and Start case object must of course be defined + system.actorOf(Props[HelloActor]) ! Start + } + + def shutdown = { + system.terminate() + } + } + +The *bash/bat* script that starts up the Akka application is copied from the Akka distribution. + +To use this archetype in your build, add the following to your ``build.sbt``: .. code-block:: scala @@ -136,6 +158,12 @@ Akka microkerneal application is simlar to a Java Command Line application. Inst mainClass in Compile := Some("HelloKernel") +For more information take a look at the akka docs + +* `Akka microkernel `_ +* `akka.kernel.Main source `_ +* `akka.kernel.Bootable docs `_ + Overriding Templates -------------------- diff --git a/src/sphinx/GettingStartedApplications/MyFirstProject.rst b/src/sphinx/GettingStartedApplications/MyFirstProject.rst index 07679dab1..eae3d2999 100644 --- a/src/sphinx/GettingStartedApplications/MyFirstProject.rst +++ b/src/sphinx/GettingStartedApplications/MyFirstProject.rst @@ -11,7 +11,7 @@ and documents to users which version of sbt you require for the build. Next, let's add the native packager to our build by created a ``project/plugins.sbt`` file with the following contents :: - addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.5-RC1") + addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2") Now, the build needs to be configured for packaging. Let's define the ``build.sbt`` file as follows diff --git a/src/sphinx/installation.rst b/src/sphinx/installation.rst index 444cd5092..3063a5d06 100644 --- a/src/sphinx/installation.rst +++ b/src/sphinx/installation.rst @@ -7,7 +7,7 @@ The sbt-native-packager is a plugin. To use it, first create a ``project/plugins .. code-block:: scala - addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.1") + addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.8.0-M2") Also, each operating system requires its own tools for download. @@ -62,4 +62,4 @@ Creating Docker images requires the use of the following command line tools: - ``docker`` It is currently not possible to provide authentication for Docker repositories from within the build. The ``docker`` binary used by the build should already have been configured with the appropriate authentication details. -See https://docs.docker.com/reference/commandline/cli/#login. \ No newline at end of file +See https://docs.docker.com/reference/commandline/cli/#login.