Skip to content
This repository has been archived by the owner on Feb 21, 2018. It is now read-only.

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Heiko Seeberger committed Dec 4, 2011
1 parent c4a4085 commit a720355
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,44 @@ sbtosgi
Plugin for `sbt`_ to create `OSGi`_ bundles. More details to come ...


Installing sbtosgi
------------------

Just add the following lines to your plugin definition (*plugins.sbt* file in the *project/* folder of your project or *plugins.sbt* file in the *~/.sbt/plugins/* directory, for details about plugins see the `sbt documentation`_), paying attention to the blank line between settings:

::
resolvers += Classpaths.typesafeResolver
addSbtPlugin("com.typesafe.sbtosgi" % "sbtosgi" % "0.1.0")


Adding sbcosgi settings
-----------------------

- Add the below line to your build definition, which will add the task *osgi-bundle*, paying attention to the blank line between settings:

::

seq(scalariformSettings: _*)


Configuring sbtosgi
-------------------

This plugin comes with the following configuration options, available as sbt settings:

- *OsgiKeys.bundleActivator*: Optional value for *Bundle-Activator* header, default is *None*
- *OsgiKeys.bundleSymbolicName*: Value for *Bundle-SymbolicName* header, default is *organization* plus *name*
- *OsgiKeys.bundleVersion*: Value for *Bundle-Version* header, default is *version*
- *OsgiKeys.dynamicImportPackage*: Values for *Dynamic-ImportPackage* header, default is the empty sequence
- *OsgiKeys.export-package*: Values for *Export-Package* header, c
- *OsgiKeys.importPackage*: Values for *Import-Package* header, default is "*"
- *OsgiKeys.fragmentHost*: Optional value for *Fragment-Host* header, default is *None*
- *OsgiKeys.privatePackage*: Values for *Private-Package* header, default is *OsgiKeys.bundleSymbolicName* plus ".*"
- *OsgiKeys.*requireBundle: Values for *Require-Bundle* header, default is the empty sequence


Mailing list
------------

Expand All @@ -23,5 +61,6 @@ This code is open source software licensed under the `Apache 2.0 License`_. Feel

.. _`sbt`: https://github.com/harrah/xsbt/
.. _`OSGi`: http://www.osgi.org/
.. _`sbt documentation`: https://github.com/harrah/xsbt/wiki/Plugins
.. _`sbt mailing list`: mailto:simple-build-tool@googlegroups.com
.. _`Apache 2.0 License`: http://www.apache.org/licenses/LICENSE-2.0.html
2 changes: 1 addition & 1 deletion src/main/scala/com/typesafe/sbtosgi/OsgiKeys.scala
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ object OsgiKeys {
val bundleVersion: SettingKey[String] =
SettingKey[String](
prefix("bundle-version"),
"Value for *Bundle-Version* header ."
"Value for *Bundle-Version* header."
)

val dynamicImportPackage: SettingKey[Seq[String]] =
Expand Down

0 comments on commit a720355

Please sign in to comment.