Improve README documentation - Githubissues

madminer-tool / madminer-workflow

Madminer complete cloud-based analysis

MIT License

4 stars 4 forks source link

Improve README documentation #7

Closed Sinclert closed 4 years ago

Sinclert commented 4 years ago

After briefly reading through the repository documentation, I think there is room for improvement, in addition to typo fixes.

This PR has reformat the README file:

Wrapping lines at width equals 120.
Move link definitions to the bottom.
Reformat long code snippets (those requiring horizontal scroll).
Reformat lists of arguments (using the - key).
Fix Analysis workflow diagram boxes.
Remove incomplete ML part header.