unibe-cns / NEAT

NEAT (NEural Analysis Toolkit)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update install instructions once NEAT is in pip

WillemWybo opened this issue · comments

Now, the instructions in INSTALL.rst are very basic. Could you update them once we have neat on pip? @jakobj

i would drop INSTALL.rst completely and document installation instructions in the README instead, no need to duplicate things. is there a reason this additional file exists?

No bad idea INSTALL.rst is loaded into the website.

ok, that's not good. i guess removing install instructions from the README is the way to go then, even if i don't like that.

i don't like it because it duplicates information. same reason as why one shouldn't duplicate code: multiplies the potential for errors, makes the project unnecessarily bigger, makes maintenance more difficult. of course one can make an argument here that this is an exception and not a lot of lines etc., and if you feel strongly about it i'm fine with it. i'm just applying heuristics ;)

Hmm another option would be to also include INSTALL.rst in the README if github renders it properly

i don't know whether that's possible, i would guess markdown does not support such imports since it's just plaintext. @benelot any idea how to best handle this?