Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jindrapetrik committed May 3, 2015
1 parent d7f2ce7 commit f459bd9
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
Java bomutils
jbomutils
========

*Java open source tools to create bill-of-materials files used in Mac OS X installers*

This is Java port of https://github.com/hogliux/bomutils

Java *bomutils* are a set of tools to create Mac OS X installer packages on foreign OSes (windows, linux, etc.) with Java.
*jbomutils* are a set of tools to create Mac OS X installer packages on foreign OSes (windows, linux, etc.) with Java.
These tools can be used as part of the cross-compilation process. In particular, it includes an open source version of the mkbom tool which is distributed as a closed-source version on Mac OS X Developer Tools.

Usage
Commandline usage
-----
To create a bom file, follow the following steps.

1. Put the installation payload into a directory. We assume the name of the directory is 'base'
2. Use mkbom to create the bom file by invoking 'java -jar bomutils.jar mkbom -u 0 -g 80 base Bom'
2. Use mkbom to create the bom file by invoking 'java -jar jbomutils.jar mkbom -u 0 -g 80 base Bom'

Ant task usage
-----
You can create BOM files from Ant using task mkbom:
```ant
<taskdef name="mkbom" classname="com.jpexs.jbomutils.ant.MkBomTask" classpath="somelibdir/jbomutils.jar" />
...
<mkbom destfile="${basedir}/Bom">
<!-- Add some files -->
<bomfileset dir="${basedir}/base" prefix="data/">
<patternset>
<include name="**/*.jpg"/>
</patternset>
</bomfileset>
<bomfileset dir="${basedir}/src" prefix="source/">
<patternset>
<include name="**/*.java"/>
</patternset>
</bomfileset>
</mkbom>
```

Original Documentation
-------------
Expand Down

0 comments on commit f459bd9

Please sign in to comment.