Skip to content

Commit 0db685e

Browse files
committed
additional, disambiguating comments
1 parent 2b3e94a commit 0db685e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

TUTORIAL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This is a tutorial on how to wrap your own C++ projects using GTSAM's python wra
77
We assume you have Python 3 installed. We support Python 3.6 and up.
88

99
We also assume some knowledge of how Python packaging and setup works. If you understand how to write your own basic `setup.py` file, you should be fine.
10+
Using this template project, you should only need to update the metadata information about your project. Check out the [python packaging website](https://packaging.python.org/tutorials/packaging-projects/) to learn more.
1011

1112
As a bonus, if you understand Cython's build process, this tutorial should be fairly intuitive.
1213

@@ -107,7 +108,7 @@ An illustrative example is provided in the `src` directory of this repository.
107108
108109
# Compiling
109110
110-
To compile and wrap the code, the familiar CMake process is followed. We create a build directory and run `cmake` and `make`
111+
To compile and wrap the code, the familiar CMake process is followed. Starting from the directory where the `setup.py` file is located, we create a build directory and run `cmake` and `make`.
111112
112113
```sh
113114
mkdir build && cd build

example/setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
],
3535

3636
packages=packages,
37+
# Load the built shared object files
3738
package_data={package:
3839
[f for f in os.listdir(package.replace('.', os.path.sep)) if os.path.splitext(f)[1] in ('.so', '.pyd')]
3940
for package in packages

0 commit comments

Comments
 (0)