summaryrefslogtreecommitdiff
path: root/README.rst
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 /README.rst
parent902500d126d4732160c46fe525e41c017864f271 (diff)
downloadpycparser-2e387d4a0bae786170c3fb424937797ddf889b51.tar.gz
Update READMEs to add more details about running examples
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index de6f4ea..a2ed094 100644
--- a/README.rst
+++ b/README.rst
@@ -165,11 +165,15 @@ Basic usage
-----------
Take a look at the |examples|_ directory of the distribution for a few examples
-of using **pycparser**. These should be enough to get you started.
+of using **pycparser**. These should be enough to get you started. Please note
+that most realistic C code samples would require running the C preprocessor
+before passing the code to **pycparser**; see the previous sections for more
+details.
.. |examples| replace:: ``examples``
.. _examples: examples
+
Advanced usage
--------------