Skip to content

Commit

Permalink
Update README to warn about missing support files
Browse files Browse the repository at this point in the history
  • Loading branch information
WasabiFan authored Dec 8, 2019
1 parent 1166ea1 commit e726a8f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/eliben/pycparser/issues/224>`_.



Using
Expand Down Expand Up @@ -161,6 +164,9 @@ See `this blog post
<https://eli.thegreenplace.net/2015/on-parsing-c-type-declarations-and-fake-headers>`_
for more details.

Note that the fake headers are not included in the ``pip`` package nor installed via
``setup.py`` (`#224 <https://github.com/eliben/pycparser/issues/224>`_).

Basic usage
-----------

Expand Down Expand Up @@ -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 <https://github.com/eliben/pycparser/issues/224>`_.

Once you unzip the ``pycparser`` package, you'll see the following files and
directories:

Expand Down

0 comments on commit e726a8f

Please sign in to comment.