Comprehensive information about using rkv is available in its online documentation, which you can also generate for local consumption:
cargo doc --open
Build this project as you would build other Rust crates:
If you specify the
backtrace feature, backtraces will be enabled in
errors. This feature is disabled by default.
Test this project as you would test other Rust crates:
The project includes unit and doc tests embedded in the
src/ files, integration tests in the
tests/ subdirectory, and usage examples in the
examples/ subdirectory. To ensure your changes don't break examples, also run them via the run-all-examples.sh shell script:
Of the various open source archetypes described in A Framework for Purposeful Open Source, the rkv project most closely resembles the Specialty Library, and we welcome contributions. Please report problems or ask questions using this repo's GitHub issue tracker and submit pull requests for code and documentation changes.
We follow Mozilla's Community Participation Guidelines while contributing to this project.
The rkv source code is licensed under the Apache License, Version 2.0, as described in the LICENSE file.