Hello everybody, Mikkel and I have been discussing where it is best to put the documentation. Mikkel pointed out that it is somewhat cumbersome to follow the current installation instructions since they are in the form of a simple INSTALL file -- the frontpage points to
http://hg.viff.dk/viff/raw-file/tip/INSTALL >From there the user must select each link, paste it in the address bar and download the right package. It would definitely be better to have an online HTML file. I think we should replace the the INSTALL file with a simple one like that: Installation Instructions ========================== Please see http://viff.dk/installation.html What do people think of a scheme like this? Is it okay to ship the releases with pointers to the web documentation? Since we have the website in reStructuredText format, we could also include (part of) it in the releases. That might be the best overall solution since it would ensure that users have the correct documentation present when downloading a release. (I just wanted to put this out here so that Mikkel and I do not sit here in our office and decide everything ourselves...) -- Martin Geisler _______________________________________________ viff-devel mailing list (http://viff.dk/) [email protected] http://lists.viff.dk/listinfo.cgi/viff-devel-viff.dk
