Add README file describing glcpp.
authorCarl Worth <cworth@cworth.org>
Tue, 11 May 2010 19:04:42 +0000 (12:04 -0700)
committerCarl Worth <cworth@cworth.org>
Tue, 11 May 2010 19:20:15 +0000 (12:20 -0700)
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.

README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ba833a4
--- /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