summaryrefslogtreecommitdiffstats
path: root/bindings/python/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/python/README.txt')
-rw-r--r--bindings/python/README.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/bindings/python/README.txt b/bindings/python/README.txt
new file mode 100644
index 0000000..ccc2619
--- /dev/null
+++ b/bindings/python/README.txt
@@ -0,0 +1,18 @@
+//===----------------------------------------------------------------------===//
+// Clang Python Bindings
+//===----------------------------------------------------------------------===//
+
+This directory implements Python bindings for Clang. Currently, only bindings
+for the CIndex C API exist.
+
+You may need to alter LD_LIBRARY_PATH so that the CIndex library can be
+found. The unit tests are designed to be run with 'nosetests'. For example:
+--
+$ env PYTHONPATH=$(echo ~/llvm/tools/clang/bindings/python/) \
+ LD_LIBRARY_PATH=$(llvm-config --libdir) \
+ nosetests -v
+tests.cindex.test_index.test_create ... ok
+...
+
+OK
+--
OpenPOWER on IntegriCloud