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

Updated README with instructions to initialize gitmodules #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −1
Open

Updated README with instructions to initialize gitmodules #3

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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Please see the [blog post that accompanies this repository](http://www.benjack.i

To build and install `python_cpp_example`, clone or download this repository and then, from within the repository, run:

```bash
git submodule update --init --recursive
```

and then


```bash
python3 ./setup.py install
```
Expand All @@ -25,6 +32,12 @@ or
pip3 install .
```

In case you're only interested in building/testing things from whitin the same directory, you could run:

```bash
python3 ./setup.py build
```

# Tests

To execute all unit tests, run the following command:
Expand All @@ -41,4 +54,4 @@ python3 ./setup.py test

# Acknowledgements

Much of the code in this repository was adapted from the [`pybind11` tutorial](http://pybind11.readthedocs.io/en/stable/basics.html) and the [`pybind11` example CMake repository](https://github.com/pybind/cmake_example).
Much of the code in this repository was adapted from the [`pybind11` tutorial](http://pybind11.readthedocs.io/en/stable/basics.html) and the [`pybind11` example CMake repository](https://github.com/pybind/cmake_example).