[sword-svn] r1969 - in trunk: . doc examples/cmdline

scribe at www.crosswire.org scribe at www.crosswire.org
Sat Sep 2 14:00:29 MST 2006


Author: scribe
Date: 2006-09-02 14:00:26 -0700 (Sat, 02 Sep 2006)
New Revision: 1969

Removed:
   trunk/debug.sh
Modified:
   trunk/ChangeLog
   trunk/INSTALL
   trunk/LICENSE
   trunk/README
   trunk/README.svn
   trunk/doc/translation-template.conf
   trunk/examples/cmdline/lookup.cpp
   trunk/usrinst.sh
Log:
Final cleanups for 1.5.9 RC


Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/ChangeLog	2006-09-02 21:00:26 UTC (rev 1969)
@@ -3,6 +3,7 @@
 
 29-Aug-2006	Troy A. Griffitts <scribe at crosswire.org>
 	Added recognition for the sysConfig parameter in SWMgr c-tor
+		(allow passing path to sword.conf to use for config)
 	Updated CORBA server to allow option -sysConf /path/sword.conf
 
 16-Aug-2006	Troy A. Griffitts <scribe at crosswire.org>

Modified: trunk/INSTALL
===================================================================
--- trunk/INSTALL	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/INSTALL	2006-09-02 21:00:26 UTC (rev 1969)
@@ -41,10 +41,7 @@
 
 After the libraries are built, one will probably wish to 'su' to root and
 'make install' to install the libraries systemwide.  One then may proceed to
-the ./apps directory.  The most basic application that is stable and easy to
-build is the cheatah frontend (./apps/X11/cheatah).  These frontends
-each have their own make system, so read the help in their respective
-directories if a problem is encountered while building.
+write and compile SWORD applications.
 
 
 MODULES
@@ -55,40 +52,47 @@
 may be obtained from:
 http://www.crosswire.org or various mirrors.
 
-In a default SWORD configuration, a module install may look like this:
+In a default SWORD configuration, the module install process may look like this:
 
 [download a module with your favourite client]
 su
 cd /usr/share/sword
 unzip ~/KJV.zip
 
+There is also an over-the-net install utility located at utilities/installmgr
 
-If you want the details, read on...
+After modules are installed, you can create fast search indecies (if you have
+compiled with clucene support), with utilities/mkfastmod
 
+If you want module configuration/installation details, read on...
 
-A file named 'mods.conf' or directory named 'mods.d' contains all configuration
-information regarding the installed modules available to the API.  The format
-of a config file is fairly straight-forward, and most modules come with their
-own .conf file, of which the contents may be appended to the mods.conf file
-or placed in the mods.d directory.
 
+A directory named 'mods.d' contains all configuration information regarding
+the installed modules available to the API.  The format of a config file is
+fairly straight-forward, and most modules come with their own .conf file,
+of which the contents may be placed in the mods.d directory.
+
 FOR A RECOMMENDED MODULE INSTALLATION SCHEME, SEE
 .../sword/samples/recommended, otherwise, the specific details follow:
 
 The API looks for its module configuration in the following sequence:
-	./mods.[conf|d]
-	$SWORD_PATH/mods.[conf|d]
-	$HOME/.sword/mods.[conf|d]
+	./sword.conf in the format:
+			[Install]
+			DataPath=/where/your/datafiles/are/installed
+		then the API will look for DataPath/mods.d
+	./mods.d
+	$SWORD_PATH/mods.d
+	$HOME/.sword/mods.d
 	or finally from information found in a system-wide configuration file
 		/etc/sword.conf in the format:
 			[Install]
 			DataPath=/where/your/datafiles/are/installed
-		then the API will look for DataPath/mods.[conf|d]
+		then the API will look for DataPath/mods.d
 
 * NOTE:
 Using the above scheme, SWORD will also determine the path to prefix to the
 specified datafile location found in the config files.  The prefix path will
-be the directory where SWORD finds mods.[conf|d].
+be the directory where SWORD finds mods.d.
 
 Sample config files can be found in: .../sword/samples
 
@@ -97,8 +101,9 @@
 
 If you would like to include support for localization, you may copy the
 locales.d directory and any of the locale files contained therein into
-the directory where your mods.d or mods.conf file exists
-(eg. to /usr/share/sword/locales.d/).
+the directory where your mods.d exists
+(eg. to /usr/share/sword/locales.d/)
+but this is done with a 'normal' sword install.
 
 
 ENJOY!!!

Modified: trunk/LICENSE
===================================================================
--- trunk/LICENSE	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/LICENSE	2006-09-02 21:00:26 UTC (rev 1969)
@@ -1,4 +1,4 @@
-The SWORD Project is (c) 1994-2005 The CrossWire Bible Society, under the
+The SWORD Project is (c) 1994-2006 The CrossWire Bible Society, under the
 terms of the GNU GPL, as stated below.
 
 NOTE: The text of the GNU GPL license is copyrighted by the Free Software

Modified: trunk/README
===================================================================
--- trunk/README	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/README	2006-09-02 21:00:26 UTC (rev 1969)
@@ -4,43 +4,61 @@
 Get the latest source and info at:
 	http://www.crosswire.org
 
-UNIX developers	You can try a './configure' (or optionally './usrinst.sh'
+UNIX DEVELOPERS
+		You can try a './configure' (or optionally './usrinst.sh'
 		for normal user configure options), then 'make' from this directory.
 		This should compile everthing needed.  You may type
 		'./configure --help' to see a list of options.
-		If all compiles file, a 'make install' (as root, probably) will
+		If all compiles fine, a 'make install' (as root, probably) will
 		install libs to your system and you may begin using the library.
-		There are a few basic tests (sword/tests), utilities
-		(sword/utilities), examples (sword/examples/*) and very basic apps
-		(sword/apps), in the tree.  The apps each have their own make system,
-		so look for a ./configure or a README.
+		There are a few basic tests (tests/), start of a test suite
+		(tests/testsuite/), utilities (utilities/), and examples
+		(examples/), in the tree.
 
+		To install modules, have a look at utilities/installmgr
+
+		For some basic lookup and search utilities, see
+			examples/cmdline/search
+			examples/cmdline/lookup
+			utilities/diatheke/
+
+		If you are an end user looking for a nice SWORD, graphical Bible study
+		software suite, then you'll probably want to download one of the
+		many nice frontends found at http://crosswire.org
+
 		./buildtest.cpp compiles to the executable 'buildtest' as a test to
 		see if the libs have compiled and can be linked against successfully.
 		This is NOT the final target of the build, nor does anything useful.
 			:)
 
 
+LANGUAGE BINDINGS
+	Other language bindings can be found in the ./bindings directory:
+	flatapi.cpp is a useful extern "C" interface for making bindings easier.
+	Kylix bindings (and maybe Delphi bindings) may be found in sword/bindings/clx
+	CORBA (orbit-c++) bindings with Java example classes in /bindings/corba
+	Perl stuff in bindings/perl
+	SWIG stuff (Python, .NET, many others) in bindings/swig
 
-Other language bindings can be found in the ./bindings directory:
-flatapi.cpp is a useful extern "C" interface for making bindings easier
-Kylix bindings (and maybe Delphi bindings) may be found in sword/bindings/clx
-CORBA (orbit-c++) bindings with Java example classes in /bindings/corba
-SWIG stuff in bindings/swig
-Perl stuff in bindings/perl
 
-C++Builder developers	You may find project files and source for the WIN32
-		frontend under apps/windows/CBuilder5/BibleCS
+C++BUILDER DEVELOPERS
+	You may find project files under lib/bcppmake
 
-Delphi developers	You will need to place sword32.dll in your winsys
-		directory or elsewhere in your path.  You can find source in
-		./apps/windoze/bcowl25/swordapi
-		or binary at: ftp://crosswire.org/pub/sword/attic/dlls.tar.gz
-		This is an older build and probably should be regenerated.
-		If you wish to add components to your toolbar, install
-		./apps/windoze/delphi20/swordvc/swmodule.pas and
-		./apps/windoze/delphi20/swordvc/swvskey.pas
+VC DEVELOPERS
+	You may find project files under lib/vcppmake
 
+DELPHI DEVELOPERS
+	You will need to place sword32.dll in your winsys
+		directory or elsewhere in your path.  You can find source to
+		build the dll using ./bindings/flatapi.cpp
+		or a binary at: ftp://crosswire.org/pub/sword/utils/win32/bcdlls.zip
+		header file is include/SwordAPI.pas
+		CLX components can be found under bindings/clx/
+
+.NET DEVELOPERS
+	Have a look in bindings/swig/vstudio/
+	Binaries may be found at: ftp://crosswire.org/pub/sword/utils/win32/vcdlls.zip
+
 Enjoy!
 
 Please email any questions or comments to: sword-feedback at crosswire.org

Modified: trunk/README.svn
===================================================================
--- trunk/README.svn	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/README.svn	2006-09-02 21:00:26 UTC (rev 1969)
@@ -1,3 +1,7 @@
+SVN trunk repository URL:
+
+https://crosswire.org/svn/sword/trunk/
+
 To generate the configure script you must run 
 
 ./autogen.sh

Deleted: trunk/debug.sh
===================================================================
--- trunk/debug.sh	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/debug.sh	2006-09-02 21:00:26 UTC (rev 1969)
@@ -1 +0,0 @@
-for i in `find . -name Makefile -exec grep -il "\-O2" {} \;`; do sed s/-O2/-O0/g $i > $i.new; mv $i.new $i; done

Modified: trunk/doc/translation-template.conf
===================================================================
--- trunk/doc/translation-template.conf	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/doc/translation-template.conf	2006-09-02 21:00:26 UTC (rev 1969)
@@ -3,7 +3,9 @@
 Description=<insert here name of language. Delete this comment.>
 
 [Text]
-<Insert after the = characters the translated booknames!. Delete this line>
+
+# Insert after the = characters the translated booknames.
+
 Genesis=
 Exodus=
 Leviticus=
@@ -72,9 +74,10 @@
 Revelation of John=
 
 [Book Abbrevs]
-<Here are the standard english booknamrs and abbrevations. Don't change
-them. Change your own ones below! Delete these two lines!>
 
+# Here are the standard english booknames and abbrevations.  Don't change
+# them.  Change your own ones below.
+
 1 C=46
 1 CHRONICLES=13
 1 CORINTHIANS=46
@@ -259,9 +262,9 @@
 ZECHARIAH=38
 ZEPHANIAH=36
 
-<here are the booknames and possible abbrevations of your language! The
-names below are german booknames, change them!. The number after the names
-are the booknumber (location of book in the bible). Delete these three lines!>
+# here are the booknames and possible abbrevations of your language!  The
+# names below are german booknames, change them. The number after the names
+# are the booknumber (location of book in the Bible).
 
 1. MOSE=1
 2. MOSE=2

Modified: trunk/examples/cmdline/lookup.cpp
===================================================================
--- trunk/examples/cmdline/lookup.cpp	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/examples/cmdline/lookup.cpp	2006-09-02 21:00:26 UTC (rev 1969)
@@ -28,7 +28,7 @@
 	}
 
 	manager.setGlobalOption("Headings", "On");
-	manager.setGlobalOption("Greek Accents", "Off");
+//	manager.setGlobalOption("Greek Accents", "Off");
 
 	target->setKey(argv[2]);
 

Modified: trunk/usrinst.sh
===================================================================
--- trunk/usrinst.sh	2006-09-02 20:28:06 UTC (rev 1968)
+++ trunk/usrinst.sh	2006-09-02 21:00:26 UTC (rev 1969)
@@ -5,13 +5,13 @@
 OPTIONS="--without-conf $OPTIONS"
 OPTIONS="--sysconfdir=/etc $OPTIONS"
 #OPTIONS="--with-vcl $OPTIONS"
-OPTIONS="--enable-debug $OPTIONS"
+#OPTIONS="--enable-debug $OPTIONS"
 #OPTIONS="--enable-profile $OPTIONS"
-#OPTIONS="--with-lucene $OPTIONS"
+OPTIONS="--with-lucene $OPTIONS"
 OPTIONS="--with-icu $OPTIONS"
 #OPTIONS="--without-curl $OPTIONS"
-#OPTIONS="--enable-tests $OPTIONS"
-OPTIONS="--disable-utilities $OPTIONS"
+OPTIONS="--enable-tests $OPTIONS"
+#OPTIONS="--disable-utilities $OPTIONS"
 
 
 CPPFLAGS="$CFLAGS $CPPFLAGS -DUSBINARY" ./configure $OPTIONS $*




More information about the sword-cvs mailing list