Update vendoring docs, clarify build deps, prepare some tags

[HadrienG2]

Following discussion with @uglyoldbob and @nazar-pc in #25 and #81, clarify how the bundled feature works in the various READMEs and prepare to tag a first alpha release of the main hwlocality library.

I'd be happy to also rename the bundled feature to some other name that contains the "vendor" keyword, like vendor-hwloc, if both of you agree that this is a better name. Feel free to tell me what you think!

In absence of answers and further suggestions, I'll merge this and create the tags at some point during the first week of January.

Fixes #25. Fixes #81. Fixes #84.

[semanticdiff-com[bot]]

Review changes with SemanticDiff.

Analyzed 2 of 7 files.

	Filename	Status
:grey_question:	.github/workflows/ci.yml	Unsupported file format
:grey_question:	Cargo.toml	Unsupported file format
:grey_question:	README.md	Unsupported file format
:grey_question:	hwlocality-sys/Cargo.toml	Unsupported file format
:grey_question:	hwlocality-sys/README.md	Unsupported file format
:heavy_check_mark:	hwlocality-sys/build.rs	Analyzed
:heavy_check_mark:	hwlocality-sys/src/lib.rs	Analyzed

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (1fde0ef) 65.81% compared to head (c9bac9d) 65.81%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #82 +/- ## ======================================= Coverage 65.81% 65.81% ======================================= Files 43 43 Lines 4599 4599 ======================================= Hits 3027 3027 Misses 1572 1572 ``` | [Flag](https://app.codecov.io/gh/HadrienG2/hwlocality/pull/82/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Hadrien+G.) | Coverage Δ | | |---|---|---| | [ubuntu-latest](https://app.codecov.io/gh/HadrienG2/hwlocality/pull/82/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Hadrien+G.) | `66.97% <ø> (ø)` | | | [windows-latest](https://app.codecov.io/gh/HadrienG2/hwlocality/pull/82/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Hadrien+G.) | `64.99% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Hadrien+G.#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[HadrienG2]

@uglyoldbob Are you fine with me just renaming it vendored? This will break your build on the next git snapshot update, but you will only need to rename the feature in your Cargo.toml to fix it.

If you don't want to fix this now, I can just keep bundled an alias to vendored for some time, say until the final release of v1.

[uglyoldbob]

That's fine with me.

On Tue, Dec 26, 2023, 10:00 Hadrien G. @.***> wrote:

@uglyoldbob https://github.com/uglyoldbob Are you fine with me just renaming it vendored? This will break your build on the next git snapshot update, but you will only need to rename the feature in your Cargo.toml to fix it.

If you don't want to fix this now, I can just keep bundled an alias to vendored for some time, say until the final release of v1.

— Reply to this email directly, view it on GitHub https://github.com/HadrienG2/hwlocality/pull/82#issuecomment-1869633082, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHBA4QCHEJXJ2AQQ4KJE33YLLYA3AVCNFSM6AAAAABBBURZC2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRZGYZTGMBYGI . You are receiving this because you were mentioned.Message ID: @.***>

[HadrienG2]

Thanks for your feedback! I switched to the "vendored" naming convention, and clarified build dependencies along the way to fix #84 .