Skip to content

Commit

Permalink
README update and dual-license.
Browse files Browse the repository at this point in the history
  • Loading branch information
adetaylor committed Aug 14, 2020
1 parent efc679f commit 1c1bf6f
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ trybuild = "1.0"
test-env-log = "0.2.2"
env_logger = "*"
cxx = "0.3.4"
rust_info = "0.3.1"
rust_info = "0.3.1"
File renamed without changes.
23 changes: 23 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ The existing cxx facilities are used to allow safe ownership of C++ types from R

# Current state of affairs

At present, this macro does not work, because there is no equivalent of the `cxxbridge` tool that knows how to expand the `include_cpp!` macro into a `cxx::bridge` mod.
At present, this macro does not work, for two reasons:
* because there is no equivalent of the `cxxbridge` tool that knows how to expand the `include_cpp!` macro into a `cxx::bridge` mod (which in turn is then used to generate `.cc` and `.h` files.)
* lots of nasty hard-coded nonsense around include paths etc.

However, this project does contain test code which does this end-to-end. At present, one of the many tests actually passes, proving that for the simplest imaginable case it is possible to tie `bindgen` into `cxx`.

Expand All @@ -51,3 +53,11 @@ This will fetch a specific fork of bindgen (see the Cargo.toml for the repo and
# Caveats

This is not an officially supported Google product.

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

0 comments on commit 1c1bf6f

Please sign in to comment.