Skip to content
This repository has been archived by the owner on Jan 17, 2020. It is now read-only.

duckAsteroid/bnd-book

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bnd-book

An online eBook about the BND tool for OSGi.

The latest copy from this repository is deployed to CloudBees: http://bnd-book.duck-asteroid.cloudbees.net/BND.html

Created from the original BND book/manual by Peter Kriens

Building

This book is composed of a series of markdown formatted sections (much like a Wiki). These are in the docs folder in the source. A scala based tool called pamflet is used to transform these sources into HTML (in the target folder).

To build the source you will need to install the simple build tool (sbt). Please follow these instructions to get this tool installed and setup.

When you have SBT installed run sbt write-pamflet from the command line. You then need to copy the images in the docs/img folder into the target folder. (the Ant build script (build.xml) has a target named init that perfoms this copying; use ant init from the command line).

To publish the eBook (bnd-book.epub) you need to install pandoc. Then use the command pandoc -f html -t epub -o bnd.book.epub target/Combined+Pages.html (or again the Ant script contains the epub target that invokes this command if it is on the PATH).

Contributors

License

All material in this repository is licensed under the Apache License version 2.0, unless explicitly stated otherwise.

Releases

No releases published

Packages

No packages published

Languages