From e726a8f963a183cb7d5f100e5a1b98df8bb2bfb7 Mon Sep 17 00:00:00 2001 From: Kaelin Laundry Date: Sun, 8 Dec 2019 14:49:22 -0800 Subject: [PATCH] Update README to warn about missing support files #224 --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index df9025c5..019d31f4 100644 --- a/README.rst +++ b/README.rst @@ -117,6 +117,9 @@ Known problems you see unexplained errors from **pycparser** after an upgrade, remove it (by deleting the ``pycparser`` directory in your Python's ``site-packages``, or wherever you installed it) and install again. +* The fake ``libc ``headers are not included in the ``pip`` package nor installed +via ``setup.py``. See `#224 `_. + Using @@ -161,6 +164,9 @@ See `this blog post `_ for more details. +Note that the fake headers are not included in the ``pip`` package nor installed via +``setup.py`` (`#224 `_). + Basic usage ----------- @@ -202,6 +208,10 @@ There are a few points to keep in mind when modifying **pycparser**: Package contents ================ +**Warning:** If you install via ``pip`` or ``setup.py``, only the `pycparser/` +directory will be installed. No other directories are included in the +package. See `#224 `_. + Once you unzip the ``pycparser`` package, you'll see the following files and directories: