normalization and move french to the end
All checks were successful
/ test_checkout (push) Successful in 1m51s

This commit is contained in:
Jean-Marie 'Histausse' Mineau 2025-09-29 20:15:36 +02:00
parent 4e38131df5
commit c3a27f8711
Signed by: histausse
GPG key ID: B66AEEDA9B645AD2
7 changed files with 57 additions and 53 deletions

View file

@ -13,8 +13,8 @@ During the packaging and testing of the tools we examined in our experiment, the
To make a tool easy to reuse, it should have documentation with at least:
- Instructions about how to install the dependencies.
- Instructions about how to build the tool (if the tool needs to be built).
- Instructions about how to use the tool (#eg command line arguments)
- Instructions about how to interpret the results of the tools (we only checked for the existence of the results in our experiment, but we found that some results can be quite obscure)
- Instructions about how to use the tool (#eg command line arguments).
- Instructions about how to interpret the results of the tools (we only checked for the existence of the results in our experiment, but we found that some results can be quite obscure).
In addition to the documentation, a minimum working example with the expected result of the tools allows a potential user to check if everything is working as intended.
This #MWE have the additional benefit that it can serve as an example in the documentation.