Getting Started
===============

The sbt-native-packager is a plugin.   To use it, first create a ``project/plugins.sbt`` file with the following. 

::

  resolvers += Resolver.url("scalasbt", new URL("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases"))(Resolver.ivyStylePatterns)
  
  addSbtPlugin("com.jsuereth" % "sbt-native-packager" % "0.1.0")


Also, each operating system requires its own tools for download.

Windows
-------

Creating Windows ``msi`` packages requires the use of the Windows Installer Xml utilities.  These are available for download here: http://wix.sourceforge.net/downloadv35.html.  The plugin has only been tested with version 3.5+.


RedHat/RPM-based linux distros
------------------------------

Creating ``rpm`` packages requires the use of the following command line tools:

- ``rpmbuild``
- ``rpm`` (optional)
- ``rpmlint`` (optional)


Debian-based linux distros
--------------------------

Creating ``deb`` packages requires the use of the following command line tools:

- ``dpkg-deb``
- ``fakeroot``
- ``chmod``
- ``lintian`` (optional)





Getting Started
===============

The sbt-native-packager is a plugin.   To use it, first create a ``project/plugins.sbt`` file with the following. 

::

  resolvers += Resolver.url("scalasbt", new URL("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-releases"))(Resolver.ivyStylePatterns)
  
  addSbtPlugin("com.typesafe" % "sbt-native-packager" % "0.1.0")


Also, each operating system requires its own tools for download.

Windows
-------

Creating Windows ``msi`` packages requires the use of the Windows Installer Xml utilities.  These are available for download here: http://wix.sourceforge.net/downloadv35.html.  The plugin has only been tested with version 3.5+.


RedHat/RPM-based linux distros
------------------------------

Creating ``rpm`` packages requires the use of the following command line tools:

- ``rpmbuild``
- ``rpm`` (optional)
- ``rpmlint`` (optional)


Debian-based linux distros
--------------------------

Creating ``deb`` packages requires the use of the following command line tools:

- ``dpkg-deb``
- ``fakeroot``
- ``chmod``
- ``lintian`` (optional)





Fix plugin organization (com.jsureth -> com.typesafe) in "Getting Started" documentation.
Fix plugin organization (com.jsureth -> com.typesafe) in "Getting Started" documentation.