Update README.md
Closes #60
Merge request reports
Activity
added docs label
added 1 commit
- b1e929b2 - DOC: new shorter README base
By Vincent Delbar on 2023-05-23T18:03:42 (imported from GitLab)
- Resolved by Cresson Remi
+1
I believe we really should have a minimalistic README, and put most of info in the documentation.
Showing:
- title + badges
- in one sentence, what is pyotb
- one snippet for
pip install pyotb
- one short python snippet example
- one link to the documentation
I am not against adding a list of cool features, but it should be short to read.
What do you think?
By Rémi Cresson on 2023-05-23T18:25:02 (imported from GitLab)
added 1 commit
- de48ef6c - DOC: move installation on top
By Vincent Delbar on 2023-05-23T18:22:22 (imported from GitLab)
added 1 commit
- 3ece8b33 - Update .gitlab-ci.yml file
By Vincent Delbar on 2023-05-23T18:40:07 (imported from GitLab)
added 1 commit
- a5d59d2f - CI: test rules instead of only for job trigger
By Vincent Delbar on 2023-05-23T18:45:44 (imported from GitLab)
added 1 commit
- 5db571d4 - CI: fix syntax error
By Vincent Delbar on 2023-05-23T18:47:56 (imported from GitLab)
added 1 commit
- f88e34b8 - DOC: suggestions
By Rémi Cresson on 2023-05-26T09:42:08 (imported from GitLab)
added 1 commit
- 932f5875 - DOC: suggestions
By Rémi Cresson on 2023-05-26T09:50:52 (imported from GitLab)
added 1 commit
- fd59486c - ENH: small typos in README
By Vincent Delbar on 2023-05-30T09:06:34 (imported from GitLab)
added 1 commit
- 14166524 - ENH: add docs link to badge
By Vincent Delbar on 2023-05-30T09:09:21 (imported from GitLab)
- Resolved by Cresson Remi
About the mermaid graph, it is nice but I fear this won't be rendered on pypi / in the package metadata section that is built from the README content
By Vincent Delbar on 2023-05-30T13:05:24 (imported from GitLab)
Edited by Cresson Remi
- Resolved by Cresson Remi
@remicress I just saw you removed the
pip install pyotb
snippet, whereas it was in your bullet points / suggestions (first comment here), is it intentional ?By Vincent Delbar on 2023-05-31T09:29:30 (imported from GitLab)
Edited by Cresson Remi
added 1 commit
- 2b9a72d9 - CI: add docs to codespell check
By Vincent Delbar on 2023-05-30T15:57:15 (imported from GitLab)
added 1 commit
- f603e9bb - ENH: markdown typos, spaces and linting in docs
By Vincent Delbar on 2023-05-30T16:00:14 (imported from GitLab)