diff options
| author | Eli Bendersky <eliben@gmail.com> | 2018-04-12 20:24:55 -0700 |
|---|---|---|
| committer | Eli Bendersky <eliben@gmail.com> | 2018-04-12 20:24:55 -0700 |
| commit | 2e387d4a0bae786170c3fb424937797ddf889b51 (patch) | |
| tree | fccad93d17c31c1772b79f277b34a0628d73926c | |
| parent | 902500d126d4732160c46fe525e41c017864f271 (diff) | |
| download | pycparser-2e387d4a0bae786170c3fb424937797ddf889b51.tar.gz | |
Update READMEs to add more details about running examples
| -rw-r--r-- | README.rst | 6 | ||||
| -rw-r--r-- | examples/README.rst | 9 |
2 files changed, 13 insertions, 2 deletions
@@ -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 -------------- 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. |