summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README62
1 files changed, 37 insertions, 25 deletions
diff --git a/README b/README
index 4b906e9..da0a9fd 100644
--- a/README
+++ b/README
@@ -1,36 +1,48 @@
-In this file:
--------------
- * General introduction
- * Requirements
- * Documentation
+README for BibleTime
+====================
-General introduction:
---------------------
-This is BibleTime 1.6.5.1. BibleTime is a Bible study application based on KDE 3.3 or later.
+BibleTime is a Bible study application based on KDE.
-Please report any bugs your find to info@bibletime.info or use the links on our webpage at
-http://www.bibletime.info. Please do not hesitate to send suggestions or criticism to info@bibletime.info.
+1. INSTALLATION
-Read the file INSTALL how to install and compile this version of BibleTime. There's also a SPEC file
-to create RPMs, it's called bibletime.spec.
+1.1 REQUIREMENTS
+ -QT 4.4+
+ -Sword 1.5.9+ (http://crosswire.org/sword)
+ -CLucene 0.9.16a+ (http://clucene.sf.net)
+ -Boost header files (libboost-dev)
+ -cmake 2.4.0+ (http://cmake.org)
-For a list of the contributors to BibleTime read the "About BibleTime" pages available in the
-"Help" menu of BibleTime.
+1.2 DEVELOPER-ONLY REQUIREMENTS
+ -po4a
+ -xsltproc, docbook-xml, docbook-xsl
-This README file contains some useful instructions and tips how to use BibleTime.
-Please read the handbook, too. It contains many instructions about the usage and
-installation of BibleTime.
+1.3 PROCEDURE
-Requirements:
--------------
-See file INSTALL for detailed installation instructions.
+In the toplevel directory of this package, you can find
+the scripts "build-debug.sh" and "build-release.sh".
-Documentation:
---------------
-You can find information about BibleTime, the installation and its usage in the following places:
+Run "build-debug.sh" to build BibleTime in debug mode.
+It will build in the directory ./build/ and install to
+./build/install/. You can run it just there, you do not
+have to install it to /usr/.
+
+For a real installation, run "build-release.sh". This will
+also build in ./build/, but then install to /usr/local.
+
+2. FEEDBACK
+
+Please report any bugs your find to bt-devel@crosswire.org or
+use the links on our webpage at http://www.bibletime.info.
+
+3. DOCUMENTATION
+
+You can find information about BibleTime, the installation
+and its usage in the following places:
o http://www.bibletime.info/
- o The BibleTime handbook available in the Help menu of the BibleTime application
+ o The BibleTime handbook available in the Help menu
+ of the BibleTime application
o There's a Bible study tutorial in the help menu
-May God, our Lord use BibleTime for his glory,
+May God, our Lord, use BibleTime for his glory.
+
The BibleTime developers, info@bibletime.info