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.

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

Improve Documentation #299

Open
3 of 5 tasks
jschwe opened this issue Jan 12, 2023 · 0 comments
Open
3 of 5 tasks

Improve Documentation #299

jschwe opened this issue Jan 12, 2023 · 0 comments

Comments

@jschwe
Copy link
Collaborator

jschwe commented Jan 12, 2023

  • Use mdbook to better structure information instead of the current status of one huge README.

  • Trim down README to be short, include at most a quick start example.

Documentation updates

  • Document that when linking msvc targets via rust, only link/lld-link are supported. Linking via cl is not supported by Rust. Should be fine when linking via CMake though.

  • Document -C linker-flavor rustflag in cases where rusts linker detection fails and when it is known to fail.

  • Document how to generate FFI bindings (bindgen, cbindgen, cxxbridge ...)

  • ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant