docs: adapt README to crates.io #60
Open
Conversation
This file contains 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
Razaloc
force-pushed
the
wip/rafaelgarrui/bmap-parserreadme
branch
from
102b612 to
fa8e7f5
Compare
|
Just in case we want to quick fix the README problem, I've committed a bump to versions. |
obbardc
suggested changes
Dec 19, 2022
Razaloc
force-pushed
the
wip/rafaelgarrui/bmap-parserreadme
branch
from
026ccf0 to
6724966
Compare
Razaloc
changed the title
Razaloc
force-pushed
the
wip/rafaelgarrui/bmap-parserreadme
branch
from
6724966 to
e87c049
Compare
Closed
|
can you drop the bors commit and the version bump commit ? |
bmap-rs and bmap-parser share the same README at this moment. This is problematic because in crates.io once published bmap-parser contains references to bmap-rs while if should be independent of it. Fix the original README file. Add a new README file for bmap-parser. Signed-off-by: Rafael Garcia Ruiz <[email protected]>
Explain context information for understanding bmap and bmap-rs. Most of this information has been obtain and adapted from; https://github.com/intel/bmap-tools/blob/master/README.md Signed-off-by: Rafael Garcia Ruiz <[email protected]>
Uses a more standard reference to the license recommended by the rust documentation (https://rust-lang.github.io/api-guidelines/necessities.html) Signed-off-by: Rafael Garcia Ruiz <[email protected]>
Razaloc
force-pushed
the
wip/rafaelgarrui/bmap-parserreadme
branch
from
fb1b0f0 to
509aa95
Compare
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.
At this moment bmap-rs and bmap-parser share the same README. This is problematic because in crates.io, once published, bmap-parser contains references to bmap-rs while if should be independent from it.
Fix the original README file.
Add a new README file for bmap-parser.
Signed-off-by: Rafael Garcia Ruiz [email protected]