Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbcoe committed Mar 31, 2024
1 parent 519637a commit 75d2112
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,17 @@ simple Python model of a C++ translation unit.

## Limitations

Currently `clang.cindex.Config.set_library_path()` must be called before
attempting to load a translation unit. This is because the libclang shared
library is not in a standard location. This may be fixed in the future.
Currently the environment variable `PY_CPPMODEL_LIBCLANG_PATH` must be defined
to specify where libclang can be found. This may be fixed in the future.

## Testing

To run the tests, run:

```sh
python3 -m venv .venv # Create a Python virtual env
python3 -m venv .venv # Create a Python virtual env.
source ./.venv/bin/activate # Activate the virtual env for bash by source.

mypy *.py --check-untyped-defs # Run mypy to check type hints
unittest discover . # Run tests
mypy *.py --check-untyped-defs # Run mypy to check type hints.
unittest discover . # Run tests.
```

0 comments on commit 75d2112

Please sign in to comment.