feat: Create documentation and prepare crate for packaging #2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created a `docs` folder to store documentation. - Moved `README.md` to `docs/README.md` and updated `Cargo.toml` accordingly. - Generated HTML documentation for `netmap-rs` using `cargo doc` and placed it in `docs/netmap_rs`. - Enhanced `src/lib.rs` with a comprehensive `# Usage` section, including a basic code example, and improved other doc comments. - Ensured `netmap-min-sys/Cargo.toml` has necessary fields for publishing and corrected an author email format. - Updated `netmap-rs/Cargo.toml` to correct an author email format. - Modified `netmap-rs/Cargo.toml` to use a versioned dependency for `netmap-min-sys`, making `netmap-rs` eligible for publishing on crates.io (once `netmap-min-sys` is published).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docsfolder to store documentation.README.mdtodocs/README.mdand updatedCargo.tomlaccordingly.netmap-rsusingcargo docand placed it indocs/netmap_rs.src/lib.rswith a comprehensive# Usagesection, including a basic code example, and improved other doc comments.netmap-min-sys/Cargo.tomlhas necessary fields for publishing and corrected an author email format.netmap-rs/Cargo.tomlto correct an author email format.netmap-rs/Cargo.tomlto use a versioned dependency fornetmap-min-sys, makingnetmap-rseligible for publishing on crates.io (oncenetmap-min-sysis published).