Revision as of 00:21, 24 September 2007

This is the collaboration/planning area for the Windows frontend of Sword.

For now, the content consists of stuff from an old wiki with broken formatting. Could someone sort it through and repair the formatting?

Getting Started

Compiling with Borland tools:

Borland has been in the habit of releasing different levels of their tools at different price tiers, and sometimes they have an 'Open' edition which is free for personal use or opensource development. Now, I'd personally recommend buying their tools. I use them for all of my commercial development and they are second to none-- truly built with the developer in mind.

Here are the steps to freely compile the free software freely :)

Download and install Borland's compiler at:

http://www.forum.nokia.com/main/0,6566,034-49,00.html
(You'll have to get a Nokia developer username/password for this first step ... not onerous.)

Download and Install Tortoise SVN:

http://tortoisesvn.net/downloads

Follow the WinCVS instructions to checkout the source code:

http://www.crosswire.org/sword/develop/biblecs/svn.jsp

For Windows development, you will need to checkout 3 SVN modules: 'sword', 'biblecs', & 'icu-sword'. All three should be checked out to checked out to the same location, so you should end up with sword, biblecs, and icu-sword directories in that folder.

Download the ICU DLL from here (grab the latest icudt??l.zip file, icudt28l.zip as of April, 2005): ftp://ftp.crosswire.org/pub/sword/utils/win32/

and place it in the CVS tree at:

sword/apps/windoze/CBuilder6/BibleCS/stage

Then change to the folder:

sword/apps/windoze/CBuilder6/BibleCS/

and double-click on:

swordprj.bpg

From the Borland IDE menu, choose Projects|Build All Projects

And that's it!!!

One recommendation: create a directory, \etc at the root of the drive where you checked out the sword source and place a file sword.conf containing something like:

[Install]
DataPath=d:/Program Files/CrossWire/The SWORD Project/

[also good to set SWORD_PATH ... lda]

This will let the sword.exe running from the Borland IDE find your SWORD modules (Bibles, etc.)

Have fun!

-Troy.

[taken from an email from Troy on sword-devel.] -- Main.MartinGruner - 13 Jul 2003

-- Main.InVerseParaclete - 06 Dec 2003
Note that the Borland C++Builder 6.0 and C++BuilderX tools are not yet officially supported for development of BibleCS software. The project files and project group files are not necessarily kept up-to-date in SVN with the officially supported CBuilder 5.0 .bpr's and .bpg's.

If you are not an experienced C++Builder user, you will probably want to peruse the sword-devel list carefully, and strongly consider connecting with a _mentor_. There are some Getting.Started oriented projects, as well as the ./tests subdirectory.

Availability of CBuilder 5.0 is _sketchy_. It is not available from Borland anymore. For obtaining ethically, you may try e-Bay (sometimes available, usually about $50 opening bid). Another source is getting a book from your library or World.Cat, hoping the CD is still there, and taking advantage of the 30-day or 60-day trial.

-- Main.ChrisLittle - 11 Apr 2005

The CBuilder 6.0 personal is also available at polish borland representative site at address http://www.borland.pl/downloads/bcb6_personal/cbuilder_6_personal.exe Do not be afraid, it is not Polish version, just plain English :-) To get this version working You'll need a free personal license from Borland accessible at http://www.borland.com/products/downloads/download_cbuilder.html .
Pleas also be informed that functionality of the personal edition is somewhat limited. The worst thing is that it lacks CodeGuard and Data Breakpoints which makes a memory problems debugging pretty hopeless.

-- Main.KrzysztofBialas - 16 Apr 2005

Compiling with Cygwin

Cygwin

The [Cygwin] provides the necessary layer ontop of the windows environment emulating API and services necessary to compile from source and run Unix software.

Install

Cygwin should be installed using standard installer available on http://www.cygwin.com. I haven't had time to check which packages are needed for the Sword build - so You'd probably be better off just installing everything (maybe except TeX and games ;-)). As of today the full install requires about

Sword

Well, everyone knows what The Sword is :-)

Getting sources

The sources should be downloaded using SVN windows client (http://tortoisesvn.tigris.org - quite a good choice). The detailed information is available at http://www.crosswire.org/sword/develop/biblecs/svn.jsp Just a small information, You need only the 'sword' product.

Necessary changes in the source tree

None necessary currently. :-)

Configure

First one needs to get the configure script. To get it You should run the =autogen.sh= from the main Sword directory. Then, the configure script should be invoked 'configure --enable-shared --with-curl --without-clucene'. This command will generate the necessary Makefiles

Compilation

This is an easy part. Just type =make=, and everything will be compiled (except from the tests)

Installation

"make install"

Final remark

I've not tested the build with the tests, alhou the tests itself bilds correctly (to do this You need to manually switch to the =tests= directory and write =make= .

I've tested the osis2mod utility, and one 'funny' thing - osis2mod compiled in cygwin environment runs 10 times slower than osis2mod compiled in BCPB 6 (!). Perhaps some optimization flags need to be tweaked, but the speed difference is really enormous...

-- Main.KrzysztofBialas - 02 May 2005