From 5b4f4e521ea8b3421030f78034cf9cf81371c9e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B8rgen=20Lund?= Date: Thu, 15 Oct 2020 20:25:23 +0200 Subject: [PATCH] Add build requirements and instructions for C# bindings to README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cd1e43..d607270 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,10 @@ Even though the core implementation is written in C++, this does not require you * Perl (via [SWIG](http://www.swig.org/)) * Python (via [SWIG](http://www.swig.org/)) * Java (via [SWIG](http://www.swig.org/)) +* C# (via [SWIG](http://www.swig.org/)) If the language of your choice is not covered by this list, feel free to [open an issue](https://github.com/CoatiSoftware/SourcetrailDB/issues) or provide a pull request. - ## Versioning The SourcetrailDB version format consists of three numbers in the format `vXX.dbYY.pZZ`. @@ -149,6 +149,20 @@ $ make Swig is configured to generate the Java binding code as a pre-build event, so you don't need to bother with updating manually. +### C# Bindings + +Requirements: +* [SWIG 3.0.12](http://www.swig.org/) is used to automatically generate C# binding code. Make sure that SWIG is added to your path environment variable. + +If you want to build the C# bindings run: +``` +$ cd path/to/SourcetrailDB +$ mkdir build +$ cd build +$ cmake -DBUILD_BINDINGS_CSHARP=ON .. +$ make +``` + ### Examples The examples help you to understand SourcetrailDB usage in practice. Please take a look at each examples README file for build and use instructions. Each example also provides a Sourcetrail project file `.srctrlprj` showing you how to use a custom indexer directly from Sourcetrail (see [Integrating with Sourcetrail](#integrating-with-sourcetrail)).