summaryrefslogtreecommitdiff
path: root/README
blob: 8ad227a6a7cede8e5dd115cf17b325f40e9c2749 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Be sure to read INSTALL for information on how to get the software
built, configured, and running properly.
___________________________________________________________________
Get the latest source and info at:
	http://www.crosswire.org

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 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 (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


C++BUILDER DEVELOPERS
	You may find project files under lib/bcppmake

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@crosswire.org