# README

# Alkitab Bible Study ${app.version}

## Contents

- What is it?
- What's New?
- System Requirements
- Upgrading to newer version
- Installing Application
- Launching Application
- 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 views and a powerful search capability. Alkitab is a front end to the "sword project" which is available for Windows, Unix/Linux, etc.

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

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

## What's New

> ver 3.0

> - Improved HTML rendering (Java FX WebView)
> - Add support for Versifications
> - Add shortcut Ctrl-L (for passage field)
> - Add shortcut Ctrl-F (for search field)
> - Updated Options background color section
> - Lots of refactoring
> - Updated to use JSword 2.0-beta (2016-03-25)
> - Updated to use Java 8 or Higher
> - Updated to use Netbeans 8.2

> ver 2.9.1

> - Add support for Ubuntu Unity

> ver 2.9

> - Fix Could not compile stylesheet
> - Fix regression Bookshelf reindex
> - Improved Session Persistence
> - Improved performance
> - Some refactoring
> - Updated to use Netbeans 7.1.2

> ver 2.8.1

> - Fix OpenJDK incompatibility
> - Various minor bug fixes
> - Various minor enhancements

> ver 2.8

> - Fix Java 7 incompatibility
> - Source Viewer enhancements (anti alias)
> - Improved startup
> - Updated to use Netbeans 7.1

## System Requirements

> - Java 8 Update 25 or higher (http://www.java.com/getjava)
> - 1024 x 768, 16-bit (thousands of colors) color display or higher
> - Mouse or equivalent pointing device

## Upgrading to newer version

> You need to remove the older version, please use one of the following:

> - Use the "[INSTALL-DIR]\Uninstaller\uninstaller"
> - Or delete the older version folder eg: "C:\Program Files\Kiyut\Alkitab-xxx"

## Installing Application

> To install the product, please do the following:

> - 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
>   or you can try the Mac OSX installer (experimental) which is available at http://www.kiyut.com/products/alkitab/download.html
>   on other platform type "java -jar setup.jar"
> - follow the on screen instruction

> Alternatively, you also could install/run the Alkitab without GUI installer:

> - unzip the file
> - copy the ../packs/Alkitab-xxx into a folder/directory of your choice
> - [Unix/Linux only] run chmod +x Alkitab-xxx/bin/alkitab
> - run or double click Alkitab-xxx/bin/alkitab.exe (Windows) or Alkitab-xxx/bin/alkitab (Unix/Linux)
> - 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.

## Launching Application

> - 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 a better idea of how to make Alkitab Bible Study a 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.