diff options
Diffstat (limited to 'libs/libbsarch/README.md')
| -rw-r--r-- | libs/libbsarch/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/libs/libbsarch/README.md b/libs/libbsarch/README.md new file mode 100644 index 0000000..671b6ff --- /dev/null +++ b/libs/libbsarch/README.md @@ -0,0 +1,25 @@ +# BSArchive DLL and C++ bindings + +BSArchive Dynamic Link Library and C++ bindings + +## How to build + +1) Create a `XEditPath` environment variable and set it to the directory containing the XEdit code +2) Build the DLL in Delphi by opening the `libbsarch.dproj` project +3) Build the LIB in Visual Studio by opening the `libbsarch.sln` project + +## How to use + +With CMake: +Use ``add_subdirectory`` and ``target_link_library`` +Then ``#include "libbsarch.h"`` for the C wrapper, or ``#include "bs_archive_auto"`` for the C++ wrapper. +See the example for code use. + +Without CMake: +Use `libbsarch.dll` (provided in delphi/lib), `libbsarch.lib` and `libbsarch.h` in your project. + +## Credits + +The original BSArchive can be found at: https://github.com/TES5Edit/TES5Edit/tree/dev/Tools/BSArchive +The version in this project had been modified for better compatibility with C/C++ and +allow the users to allocate their own memory in some cases. |