Skip to content

Commit

Permalink
Remove references to ICU from Readme and fix style
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias-klein committed Jan 21, 2024
1 parent a5b9f4f commit 503b12b
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# sword-build-win32

This repository contains batch scripts and GitHub CI scripts that build the [SWORD library](https://www.crosswire.org/sword/) and all its dependencies for the WIN32 platform (using the Visual Studio 2019 C++ compiler). The SWORD library gives access to bible text modules and related ressources. The released files are used to build the Windows version of [node-sword-interface](https://github.com/tobias-klein/node-sword-interface).

When cloning this repository you must use the option `--recurse-submodules` so that all submodule repos are available immediately. You also need to have [git-lfs](https://git-lfs.github.com/) installed, because some of the modules are using lfs properties.
This repository contains batch scripts and GitHub CI scripts that build the
[SWORD library](https://www.crosswire.org/sword/) and all its dependencies
for the WIN32 platform (using the Visual Studio 2019 C++ compiler).
The SWORD library gives access to Bible text modules and related ressources.
The released files are used to build the Windows version of
[node-sword-interface](https://github.com/tobias-klein/node-sword-interface).

When cloning this repository you must use the option `--recurse-submodules`
so that all submodule repos are available immediately. You also need to have
[git-lfs](https://git-lfs.github.com/) installed, because some of the modules
are using lfs properties.

The following libraries are automatically built with every push on this repo:
- zlib
- XZ Utils
- bzip2
- curl
- icu
- SWORD

Furthermore, when a release is created, binaries are automatically uploaded as release artifacts.
Expand All @@ -18,16 +25,18 @@ Furthermore, when a release is created, binaries are automatically uploaded as r

### Definition SWUSINGDLL

When linking against sword.dll you need to have the define `SWUSINGDLL` set in your application's build environment. This ensures that symbols are being imported correctly (see [defs.h](https://github.com/bibletime/crosswire-sword-mirror/blob/trunk/include/defs.h#L68) in SWORD headers).
When linking against sword.dll you need to have the define `SWUSINGDLL`
set in your application's build environment. This ensures that symbols
are being imported correctly (see [defs.h](https://github.com/bibletime/crosswire-sword-mirror/blob/trunk/include/defs.h#L68)
in SWORD headers).

### List of libraries to link against (SWORD and Dependencies)

This is a sample list of libraries to link against (example from [node-sword-interface](https://github.com/tobias-klein/node-sword-interface), note that the syntax is *node-gyp* specific):
This is a sample list of libraries to link against (example from
[node-sword-interface](https://github.com/tobias-klein/node-sword-interface),
note that the syntax is *node-gyp* specific):

'-l<(module_root_dir)/build/sword-build-win32/lib/sword.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/icuuc.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/icuin.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/icudt.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/libbz2.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/liblzma.lib',
'-l<(module_root_dir)/build/sword-build-win32/lib/libcurl_imp.lib',
Expand All @@ -38,6 +47,9 @@ This is a sample list of libraries to link against (example from [node-sword-int

### Include path

Besides providing the list of linked libraries you also need to make sure that the include path is configured correctly, see this example from [node-sword-interface](https://github.com/tobias-klein/node-sword-interface), note that the syntax is *node-gyp* specific:
Besides providing the list of linked libraries you also need to make sure that
the include path is configured correctly, see this example from
[node-sword-interface](https://github.com/tobias-klein/node-sword-interface),
note that the syntax is *node-gyp* specific:

"<(module_root_dir)/build/sword-build-win32/include"

0 comments on commit 503b12b

Please sign in to comment.