added README to examples and improved database version check when used from Sourcetrail

2018-12-18 10:48:43 +01:00
parent f4cf5f171a
commit aa85d20e73
13 changed files with 190 additions and 140 deletions
@@ -0,0 +1,24 @@
+
+## Poetry Indexer Example
+
+### Requirements
+
+* CMake
+* C++ Compiler
+
+### Building
+
+* Run cmake with `BUILD_EXAMPLES=ON`
+* Build target `poetry_indexer`
+
+### Running from Command Line
+
+Invoke binary located in the build directory:
+
+```
+$ poetry_indexer path/to/database_file.srctrldb path/to/examples/cpp_poetry_indexer/data/e_e_cummings_-_in_just-.txt
+```
+
+### Running with Sourcetrail
+
+Open `poetry_indexer.srctrlprj` located in the build directory with Sourcetrail and index the project.