Creating FreeGuide installer packages

This page tells you how to make installers (EXEs for Windows, RPMs, debs etc for Linux).

Windows

For building windows package you need to have the NSIS tool for creating windows installers - NSIS.

If you are building on Windows, install NSIS and make sure the makensis command is in your PATH. Then go to the FreeGuide root directory and type:

 ant dist-exe

If you are on Linux, install NSIS (apt-get install nsis or equivalent may be enough) and then go to the FreeGuide root directory and type:

 ant dist-exe

Linux .deb

To make a .deb of FreeGuide:

Modify the file install/linux/debian/changelog to add a new entry for the current version.

Now install the relevant packages:

 sudo apt-get install gnupg debhelper devscripts dpatch

Ensure you have a gpg key with which to sign the package. This command will create one:

 gpg --gen-key

Now run this in the root directory:

 ant dist-deb

Get in touch with the developers if this fails.

Linux .rpm

To make an RPM of FreeGuide, run this in the root directory:

 ant dist-rpm

Get in touch with the developers if this fails.

Linux .tar.gz

To make a .tar.gz file containing every file installed by the RPM or deb installers, run this in the root directory:

 ant dist-tgz

Get in touch with the developers if this fails.

Mac OS X

You need to run "ant" in the FreeGuide root source directory (the one containing the file build.xml) first. It will prepare some files by setting their version number, compile the application and all the plugins, and pack things into JAR files.

This assumes that you have got xmltv working somehow.

Creating the Package

How to create a Mac OS X Application Bundle. Download and install the latest version of XCode from Apple Developer's website. Download and extract the Freeguide source code you wish to create the package from. Load the Jar Bundler App, which can be found in the following path after Xcode has been installed /Developer/Applications/Java Tools/

For the main class, choose the startup.jar file from the Freeguide source directory. Under class path and files, choose all of the files found in the lib directory that is under the Freeguide source directory. For the command line options enter the following:

--doc_directory ./doc --install_directory .

Then check off use Macintosh Menu Bar. In the JVM Version, select 1.5+ for the best results.

In the arguments to commandline dialog box, enter the following:

-Dapple.laf.useScreenMenuBar=true OR check the check box next to Use Macintosh Menu Bar.

In the JVM Version dialog box, if you want Freeguide to use the Macintosh menu bar, select version 1.4+ of the JVM, otherwise choose any JVM.

Under the Properties Dialog box.

Check Set Working Directory to inside Application Package

Select choose icon and choose a "provided" icns file or make your own.

make your own icons coming soon

Then select create application. Choose a file name, I would suggest Freeguide. Remember the location where the app bundle is created, because you will need to enter into its directory structure like so:

cd "PATH_TO_APP_BUNDLE/Freeguide.app/Contents/MacOS/" then copy the doc files from the source tarball to the path stated above like so

cp -RLv FREEGUIDE_SOURCE/doc .

Configuring the Package

Coming soon...

TODOs

• How to create the Freeguide icons (.icns files)
• Put the command line options in.

Notes

I do not believe this creates universal java apps.