Mention public API in readme #682
Conversation
Codecov Report
@@ Coverage Diff @@
## master #682 +/- ##
=======================================
Coverage 99.31% 99.31%
=======================================
Files 72 72
Lines 10257 10257
=======================================
Hits 10187 10187
Misses 70 70
Flags with carried forward coverage won't be shown. Click here to find out more. |
README.md
Outdated
| @@ -42,8 +42,7 @@ $ cmake .. | |||
| $ cmake --build . | |||
| ``` | |||
|
|
|||
| This will build Fizzy as a library and since there is no public API | |||
| (the so called *embedder API* in WebAssembly) yet, this is not very useful. | |||
| This will build Fizzy as a library. [C API] is provided for embedding Fizzy engine in applications, as well as [Rust binding]. | |||
There was a problem hiding this comment.
I think for Rust we should give an actual example using the published crate, and perhaps link to crates.io and/or docs.rs (for documentation).
README.md
Outdated
| @@ -42,8 +42,7 @@ $ cmake .. | |||
| $ cmake --build . | |||
| ``` | |||
|
|
|||
| This will build Fizzy as a library and since there is no public API | |||
| (the so called *embedder API* in WebAssembly) yet, this is not very useful. | |||
| This will build Fizzy as a library. [C API] is provided for embedding Fizzy engine in applications, as well as [Rust binding]. | |||
There was a problem hiding this comment.
For C perhaps having a simple example would be useful, just to give an indication. Something which loads a wasm file and executes ta function called "main"?
There was a problem hiding this comment.
We also have the how to include fizzy in cmake. We have a test for that.
There was a problem hiding this comment.
@gumb0 perhaps this cmake example would be useful. See test/integration/cmake_package/use_fizzy.
There was a problem hiding this comment.
I'm not sure yet how to describe it other than mentioning find_package(fizzy CONFIG REQUIRED). Can look into it later, or @chfast perhaps could help.
There was a problem hiding this comment.
Added a sentence anyway.
|
@gumb0 do you want to drop the rust part? I can create a PR and deal with some rust description later. |
Yes, would be good. |
gumb0
force-pushed
the
capi-readme
branch
2 times, most recently
from
b3fecf1
to
2eee52e
Compare
gumb0
force-pushed
the
capi-readme
branch
2 times, most recently
from
d0e333a
to
b6782c0
Compare
| ```c | ||
| #include <fizzy/fizzy.h> | ||
|
|
||
| bool execute_main(const uint8_t* wasm_binary, size_t wasm_binary_size) |
There was a problem hiding this comment.
It would be nice to create matching integration test at some point to make sure this example continue to work.
Co-authored-by: Alex Beregszaszi <alex@rtfs.hu>
No description provided.