[pypy-commit] cffi default: start to rewrite README

fijal noreply at buildbot.pypy.org
Thu Jun 14 16:09:42 CEST 2012


Author: Maciej Fijalkowski <fijall at gmail.com>
Branch: 
Changeset: r336:7f4364b67ba6
Date: 2012-06-14 16:09 +0200
http://bitbucket.org/cffi/cffi/changeset/7f4364b67ba6/

Log:	start to rewrite README

diff --git a/README.md b/README.md
--- 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
 -------


More information about the pypy-commit mailing list