Readme - Alkitab Bible Study

# README

# Alkitab Bible Study ${app.version}

## Contents

- What is it?
- What's New?
- System Requirements
- Installation and Run
- Bug Reports and Feedback
- Licensing and legal issues

## What is it?

> Alkitab Bible Study is free desktop based Bible Study tool. It features rich and user friendly Bible study tools. It support parallel view and powerful search capability. Alkitab is a front end to the sword project which is available for Windows, Unix/Linux, etc.

> Alkitab requires Java 1.5 or higher (http://www.java.com/getjava).
> As a cross platform application, Alkitab runs on any platform that support Java 1.5
> eg: Microsoft Windows, Unix or Linux, etc.

> The latest news about Alkitab Bible Study can be found on http://www.kiyut.com

> Note: You need to have Java 1.5 or higher, for installation and use.
> You can download from Sun Java site (http://www.java.com/getjava)

## What's New

> ver 1.5.1

> - Improved Installer
> - Fix Closeable Tab title space with the x button
> - Fix Navigation panel for Biblical Texts
> - Updated to use JSword 1.6 (20080920)

> ver 1.5

> - Add Public API for Bookshelf Popup Menu
> - Add popup menu "Open" for Bookshelf
> - Add popup menu "Properties" for Bookshelf
> - Add some missing localization for in_ID
> - Some bug fixes
> - Updated to use JSword 1.6 (20080913)

> ver 1.4

> - Add Alkitab Localization in_ID
> - Improved ToolTip implementation
> - Fix Commentaries bug
> - Fix Parallel View remove book <= 1
> - Fix SwingFX related code
> - Various bug fixes and small enhancement
> - Updated to use JSword 1.6 (20080823)

## System Requirements

> - Java 1.5 or higher - you can download from Sun Java site (http://www.java.com/getjava)
> - 1024 x 768, 16-bit (thousands of colors) color display or higher
> - Mouse or equivalent pointing device

## Installation and Run

> To install the product, please do the following:

> Mac OSX: You can try the Mac OSX installer (experimental) which is available at http://www.kiyut.com/products/download.html or you can follow the instruction below.

> - unzip the file
> - on Microsoft Windows double click setup.exe or setup.jar
>   on Linux/Unix run setup, if necessary chmod +x setup to make it executable
>   on Mac OSX run the Java setup by clicking on the setup.jar
>   other platform type "java -jar setup.jar"
> - follow the on screen instruction

> note: uninstall or remove the previous version if exist, simply delete the folder will be fine. Or you need to install in different folder.

> Alternatively, you also could install/run the Alkitab without GUI installer (Unix/Linux user):

> - unzip the file
> - copy the ../packs/Alkitab-xxx into a folder/directory of your choice
> - Unix/Linux run chmod +x Alkitab-xxx/bin/alkitab
> - you are done

> note: the installer wizard is basically just copying the folder as above into your preferred folder asked by the wizard and create icon shortcut.

> To run the product after install:

> - on Microsoft Windows just run Alkitab from Desktop Shortcut or Start Menu - All Programs - Kiyut - Alkitab
>   on Mac OSX
>   - open the Terminal program (inside Applications folder - Utilities)
>   - type "cd [INSTALL-DIR]/bin/" eg: cd /home/user-name/Kiyut/Alkitab/bin/
>   - type "./alkitab"
>   - or you can just run Alkitab by double click the file alkitab at "[INSTALL-DIR]/bin/alkitab" eg: /Applications/Kiyut/Alkitab/bin/alkitab and choose open with terminal
>   on other platform run [INSTALL-DIR]/bin/alkitab, if necessary chmod +x alkitab to make it executable
> - enjoy the product

## Bug Reports and Feedback

> For technical support, bug reports, feature requests, or any feedback, please send email to support@kiyut.com or visit our support page. If possible, please include details of your development environment (eg: Operating System, Java version, etc), steps to recreate the problem and attach any examples you have where applicable.

> Your feedback is important to us in order to get an idea of how to make Alkitab Bible Study better product for you. If you have an idea for a new feature, or a better way of doing something, please do not hesitate to drop us a note at support@kiyut.com or visit our support page.

## Licensing and legal issues

> This work has been placed into the public domain. You are free to use this work in any way you wish.

> Important: This computer program also includes other components developed by third party. Each component is governed by its own license which may not under public domain license.

> For legal and licensing issues, please read the all LICENSE files in the legal folder.

> Thank you for using Alkitab Bible Study.