ynkmr/SourcetrailDB
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme (#15)

Browse Source 
* add more information on "Adding new Language Support"
This commit is contained in:
Malte Langkabel
2019-11-19 18:40:10 +01:00
committed by GitHub
parent d0545deb20
commit 980ea5dafc
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -1
View File
@@ -1,4 +1,5 @@
# SourcetrailDB # SourcetrailDB
Library to export [Sourcetrail](https://www.sourcetrail.com/) compatible database files for writing custom indexers 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 ## 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) * [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 ## 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: 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: