online docu in README.md - Githubissues

BackofenLab / Cherri

https://backofenlab.github.io/Cherri/

GNU General Public License v3.0

0 stars 0 forks source link

online docu in README.md #52

Open martin-raden opened 1 year ago

martin-raden commented 1 year ago

Hi all,

I have

[x] enabled github pages export to provide a documentation view without the github details
[x] added a workflow figure and a link to the github page

I think we need:

[ ] a (rough) "table of content" to ease the browsing of the documentation, such that one can jump to a point of interest
[ ] some general workflow details (as given in the paper; maybe with the pos/neg training data image) how it works. alternatively, we can link the paper in the end... but not the most supernice version.. ;)