From 980ea5dafc3ef637d352172b5ab89869ab2f1d45 Mon Sep 17 00:00:00 2001 From: Malte Langkabel Date: Tue, 19 Nov 2019 18:40:10 +0100 Subject: [PATCH] Update readme (#15) * add more information on "Adding new Language Support" --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a8263eb..ee2a08a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # SourcetrailDB + Library to export [Sourcetrail](https://www.sourcetrail.com/) compatible database files for writing custom indexers @@ -17,10 +18,18 @@ The SourcetrailDB project provides write access to [Sourcetrail](https://www.sou ## Projects Using SourcetrailDB -The following list of projects already use SourcetrailDB API to extend the language support of Sourcetrail. If you plan on starting a language package on your own, take a look at our [Language Extension Guide](LANGUAGE_EXTENSION_GUIDE.md). + +The following list of projects already use SourcetrailDB API to extend the language support of Sourcetrail. * [SourcetrailPythonIndexer](https://github.com/CoatiSoftware/SourcetrailPythonIndexer) +## Adding new Language Support + +When you plan on starting a Sourcetrail language package on your own, you can use whatever programming language you like for this task. The only requirement is: you need to make calls to SourectrailDB to enter the information your indexer records to the Sourcetrail database. + +__To get an overview on everything involved, please take a look at our [Language Extension Guide](LANGUAGE_EXTENSION_GUIDE.md).__ + + ## Supported Language Bindings Even though the core implementation is written in C++, this does not require you to write your indexer in C++ as well. Instead you can use a language binding (e.g. see [SWIG](http://www.swig.org/)). These language bindings are already available: