summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2010-05-11 12:04:42 -0700
committerCarl Worth <cworth@cworth.org>2010-05-11 12:20:15 -0700
commitbeb26e8ac3152c4a7be43d7ee068b50e17b3ba18 (patch)
tree6700c33e1c66c91dd3a4a25fafe5df844b2c597e
parente8c790b3ceab06eb0433c3a234d3e16980f7ef19 (diff)
Add README file describing glcpp.
Mostly this is a place for me to write down the URLs of the GLSL and C99 specifications that I need to write this code.
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000000..ba833a49ff
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+glcpp -- GLSL "C" preprocessor
+
+This is a simple preprocessor designed to provide the preprocessing
+needs of the GLSL language. The requirements for this preprocessor are
+specified in the GLSL 1.30 specification availble from:
+
+http://www.opengl.org/registry/doc/GLSLangSpec.Full.1.30.08.pdf
+
+This specification is not precise on some semantics, (for example,
+#define and #if), defining these merely "as is standard for C++
+preprocessors". To fill in these details, I've been using the C99
+standard (for which I had a convenient copy) as available from:
+
+http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf