summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2018-04-12 20:24:55 -0700
committerEli Bendersky <eliben@gmail.com>2018-04-12 20:24:55 -0700
commit2e387d4a0bae786170c3fb424937797ddf889b51 (patch)
treefccad93d17c31c1772b79f277b34a0628d73926c /examples
parent902500d126d4732160c46fe525e41c017864f271 (diff)
downloadpycparser-2e387d4a0bae786170c3fb424937797ddf889b51.tar.gz
Update READMEs to add more details about running examples
Diffstat (limited to 'examples')
-rw-r--r--examples/README.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/examples/README.rst b/examples/README.rst
index a828cce..5e7251e 100644
--- a/examples/README.rst
+++ b/examples/README.rst
@@ -1 +1,8 @@
-Run these examples from the root directory of pycparser
+Run these examples from the root directory of pycparser.
+
+Please note that most realistic C code samples would require running the C
+preprocessor before passing the code to **pycparser**; see the `README file
+<https://github.com/eliben/pycparser/blob/master/README.rst>`_ and `this blog
+post
+<https://eli.thegreenplace.net/2015/on-parsing-c-type-declarations-and-fake-headersfor
+more details.