Small re-organization of documentation files #391
Draft
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.
Description
Currently, there are multiple documentation files that are not connected in any way. This PR adds a brief project description (previously split into two places), licence badge and links to all the other documentation files (BUILD.md and HOWTO.md). Small re-formatting was also applied to BUILD.md and HOWTO.md without removing existing or adding any new content.
I considered adding more examples to HOWTO about key management. But once you configure openssl to use the provider (covered in HOWTO.md) the rest is really more about other tools (e.g. p11-kit) than the provider.
I also did not cover tests but we can do that later if needed.
Resolves #301.
Checklist
Not applicable
Reviewer's checklist: