summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2013-12-02 12:49:17 +0000
committerPhilip Withnall <philip.withnall@collabora.co.uk>2013-12-03 08:51:56 +0000
commit96f63f46a0f1fe7b04d0420464aa7ca0e5d7f84a (patch)
tree4e0cded9e02c1fa42152afc13996a5dcecb49a09 /README
Initial commit
This is a basic working version of a clang plugin which loads GIR typelibs and adds the GCC/Clang ‘nonnull’ attribute to nodes in Clang’s AST according to the GIR annotation data.
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..44cce8d
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+gnome-clang
+===========
+
+gnome-clang is a set of tools and plugins for Clang which aim to improve the
+usefulness of Clang for developing GNOME applications.
+
+The first (and currently only) plugin in this set is a static analysis plugin to
+utilise GObject introspection annotations to automatically add attributes to
+functions and parameters in C code.
+
+Dependencies
+============
+
+ • glib-2.0 ≥ 2.38.0
+ • gio-2.0 ≥ 2.38.0
+ • gobject-introspection-1.0 ≥ 1.38.0
+ • llvm ≥ 3.5svn
+
+Licensing
+=========
+
+gnome-clang is licensed under the GPL; see COPYING for more details.
+
+Contact
+=======
+
+Philip Withnall <philip.withnall@collabora.co.uk>
+http://people.collabora.com/~pwith/gnome-clang/