From e44767e6d2c79ac0224b46144b5cd9c508d090e1 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Thu, 3 Apr 2014 09:40:37 -0400 Subject: [PATCH] Bump all docs for 0.7.0-RC2 release. --- README.md | 95 ++----------------------------------- src/sphinx/installation.rst | 4 +- 2 files changed, 6 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index 2aac166d5..ecfa2fc62 100644 --- a/README.md +++ b/README.md @@ -19,101 +19,14 @@ This is a work in process project. The goal is to be able to bundle up Scala so Add the following to your `project/plugins.sbt` file: - addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.6.4") + addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.0-RC2") -Then, in the project you wish to use the plugin, You need to select what kind of project you are packaging: +## Documentation ## -### Java Application ### +There's a complete "getting started" guide and more detailed topics available at [the sbt-native-packager site](http://scala-sbt.org/sbt-native-packager). -If you are packaging a Java Application, this implies that you have *one* main method defined in the project. The -native packager will generate two scrips to run your application (one for 'nix [bash] and one for windows [bat]). The -generic layout of your application will be: - - bin/ - <- bash script - .bat <- windows script - lib/ - *.jar <- binaries +Please feel free to [contribute documentation](https://github.com/sbt/sbt-native-packager/tree/master/src/sphinx), or raise issues where you feel it may be lacking. -When mapping to debian or RPM, the packager will create symlinks in /usr/bin to the installation directory of your -program. If you include a `conf/` directory with configuration, this will show up as a symlink under `/etc//`. -On windows, the directory structure remains unchanged, however the MSI will include a hook to automatically add -the `bin/` directory to the windows PATH. -Here's what to add to your `build.sbt`: - - packageArchetype.java_application - -If you'd like to add additional files to the installation dir, simply add them to the universal mappings: - - import com.typesafe.sbt.SbtNativePackager.Universal - - mappings in Universal += { - file("my/local/conffile") -> "conf/my.conf" - } - -The above adds a configuration file from the local project at `my/local/conffile` into the installation directory -at `conf/my.conf`. - - -### Java Server Application (Experimental) ### - -If you are packaging a server, the configuration will be similar to a vanilla Java Application, except that the native -packager will include service hooks inside the MSI, DEB and RPM. For DEB, these hooks will use upstart. For RPM, -they will use init.d and for MSIs, there will be windows service hooks. - -To try out the experimental java server archetype, add this to your `project/plugins.sbt`: - - addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "0.7.0-M2") - -Here's what to add to your `build.sbt`: - - packageArchetype.java_server - -For debian packaging there are a few things generated for you - -* A template folder `/var/log/` -* A symlink `/installdir//logs` to `/var/log/