Add Gitter badge
[m6w6/ext-psi] / README.md
index 164a7982ad3f927e934a21b2ce5810b74c6c6bff..f28cff3c0802386771d3f79f8a4254671d045e6b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # ext-psi
 
+[![Join the chat at https://gitter.im/m6w6/ext-psi](https://badges.gitter.im/m6w6/ext-psi.svg)](https://gitter.im/m6w6/ext-psi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 [![Build Status](https://travis-ci.org/m6w6/ext-psi.svg?branch=master)](https://travis-ci.org/m6w6/ext-psi)
 
 PSI is a PHP extension, which provides a foreign function interface through
@@ -12,6 +14,9 @@ The acronym PSI may be read as:
 The latter because PSI can be configured to include declarations for most of the
 [base definitions and system interfaces of POSIX.1-2008](http://pubs.opengroup.org/onlinepubs/9699919799/).
 
+> **WARNING:**  
+> This is heavy WIP. Only a small part of configuration and implementation has been completed yet.
+
 ## Features
 
 * standard scalar types mapped to stdint types
@@ -22,6 +27,9 @@ The latter because PSI can be configured to include declarations for most of the
 
 ## Installing
 
+> **WARNING:**  
+> This is heavy WIP. Installation only works from a source checkout yet.
+
 ### PECL
 
 This extension is distributed through [PECL](http://pecl.php.net) and can be
@@ -102,6 +110,11 @@ The following modules are available to select:
 ### --with-psi-libjit
 **Path to libjit.**
 
+> **WARNING:**  
+> We currently rely on a patched libjit, because of an apparent bug in how
+> libjit creates closures, which still needs to be verified, though.
+> See https://github.com/m6w6/libjit for the preliminary patch.
+
 ### --with-psi-libffi
 **Path to libffi.**
 
@@ -214,7 +227,7 @@ extern char *strerror(int errnum);
 
 You may specify a non-standard calling convention in place of `extern`, where `default` and `cdecl` have the same meaning as `extern`.
 
-Additionally recognized calling conventions include: `mscdecl`, `stdcall` and `fastcall`.
+Additionally recognized calling conventions include: `stdcall` and `fastcall`.
 
 ### Constants