aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/deps/pybind11/README.md
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2019-02-03 11:37:30 +0100
committerMartin Braun <martin.braun@ettus.com>2019-02-22 16:56:52 -0800
commit51bbf548c9b442d0b53b6c8de5f89403de274424 (patch)
tree67bc4c4ffb5192afa958d92ae2679706aead9884 /host/lib/deps/pybind11/README.md
parent435a1f13b8b38e325bf46cd6bec9061ee9f0172d (diff)
downloaduhd-51bbf548c9b442d0b53b6c8de5f89403de274424.tar.gz
uhd-51bbf548c9b442d0b53b6c8de5f89403de274424.tar.bz2
uhd-51bbf548c9b442d0b53b6c8de5f89403de274424.zip
deps: Add PyBind11
Diffstat (limited to 'host/lib/deps/pybind11/README.md')
-rw-r--r--host/lib/deps/pybind11/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/host/lib/deps/pybind11/README.md b/host/lib/deps/pybind11/README.md
new file mode 100644
index 000000000..16cc54ebb
--- /dev/null
+++ b/host/lib/deps/pybind11/README.md
@@ -0,0 +1,23 @@
+# PyBind11: Third-Party Dependency for UHD
+
+Version: 25abf7ef (post-2.2.4)
+
+PyBind11 is a replacement for Boost.Python. Unlike Boost.Python, however, we
+ship it with the UHD repository instead of relying on it to be there external to
+the repository. The main reason for this is that PyBind11 is not packaged with
+most distributions at this time. It also allows us to lock down the version of
+PyBind11 used; with Boost, we often have to apply hacks to make sure UHD works
+across all of the Boost versions that we support.
+
+## License for PyBind11
+
+As a seperate, third-party project, PyBind11 has a different license from UHD.
+See the LICENSE file in the same directory as this readme. PyBind11 has a
+3-clause BSD-style license.
+
+## Importing into UHD
+
+In order to copy PyBind11 into UHD, only the `include/` subdirectory from the
+PyBind11 repository was copied into UHD.
+To save space, all comments were stripped from PyBind11 source files, except for
+the copyright header, using the `remove_comments.py` script.