Added and amended README.md files for all tools #973
Merged
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.
The documentation is sliding out of date from the tools because the wiki and the source code are decoupled. So I've made README.md files for all the tools (and parts of the tools directory structure) and harmonized the contents.
I've used some AI magic to ensure that the source and readme documentation matches - but there might be some funnies in there - I did a fast manual check, but it's more important to have the documentation in place and ready for update than missing completely.
ofc there is the question of harmonizing this with the wiki... but that's a separate issue.