search

MicroMedIAn / PathAIA

Digital Pathology Analysis Tools
GNU General Public License v3.0
3 stars 3 forks source link

Create nice README #12

Closed pilarOrtega closed 3 years ago

pilarOrtega commented 3 years ago

Some inspiration here: https://www.makeareadme.com/

schwobr commented 3 years ago

Is the doc hosted somewhere ?

ArnaudAbreu commented 3 years ago

Nope, I guess we have two main options :

github pages -> https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/

Pypi hosting -> https://wiki.python.org/moin/PyPiDocumentationHosting

The latter implies to publish the package on pypi, which is something we should do. But we'd rather go public on github first I guess... So first option can be convenient, at least at the beginning.

ArnaudAbreu commented 3 years ago

Crap...

Capture d’écran 2021-03-25 à 09 57 24

schwobr commented 3 years ago

Well we can make it public I guess, doubt anyone will notice it right now anyway.

Also made a first draft for the readme in #16 , it is far from complete though.