summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaciej Fijalkowski <fijall@gmail.com>2012-06-14 16:09:30 +0200
committerMaciej Fijalkowski <fijall@gmail.com>2012-06-14 16:09:30 +0200
commitdce5a0769a8b17d1ccdfed5e7435efcdab2e2e8a (patch)
tree64dfdd256861813afc84137893e9fbf414238fe6 /README.md
parent063c3cb4d8c8464f90e08e092ce3edc3dbe6ea41 (diff)
downloadcffi-dce5a0769a8b17d1ccdfed5e7435efcdab2e2e8a.tar.gz
start to rewrite README
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8df6601..ed35061 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,24 @@
cffi
====
-Foreign Function Interface for Python calling C code.
+Foreign Function Interface for Python calling C code. The aim of this project
+is to provide a convinient and reliable way of calling C code from Python.
+The interface is based on `luajit FFI`_ and follows few principles:
+
+* Able to call C from Python without introducing a third language
+ (unlike Cython or SWIG)
+
+* Keep all the python-related logic in Python instead of C (unlike CPython
+ native C extensions)
+
+* Be complete and work on the level of API (unlike ctypes)
+
+.. _`luajit FFI`: http://luajit.org/ext_ffi.html
+
+Simple example
+--------------
+
+xxx
Contact
-------