Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README to warn about missing support files #358

Closed
wants to merge 1 commit into from
Closed

Update README to warn about missing support files #358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.rst
View file
Open in desktop
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