Mikkel Krøigård <[EMAIL PROTECTED]> writes: >> 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? > The solution seems very simple to me. Include instructions both on the > download page and in the INSTALL file.
Yes, I think we should do that too -- so I think we should move the documentation to the website repository where we will rewrite it as reStructuredText documents. Since these documents are quite readable as-is, we can simply copy them to the release. That way we wont have to maintain two files with the installation guide. Of course we need to write the installation instructions with care if we want them to do double duty like that. But I think it should be no problem. I would like to move the NEWS (already duplicated on the homepage), AUTHORS (so that we can link to it from the footer of the pages), and TODO (maybe call it a road-map?), and INSTALL files like that. I think we can leave the README file behind since we probably want different content in that compared to the frontpage of the website. Since the website is ultra-portable, then we might want to bundle all the documentation under /docs in a release? Oh, and should I have named the directory /doc instead? That would have been short for "documentation" whereas /docs must be short for "documents" which is actually not what I intented. -- Martin Geisler
pgpdAwGnmuHlj.pgp
Description: PGP signature
_______________________________________________ viff-devel mailing list (http://viff.dk/) [email protected] http://lists.viff.dk/listinfo.cgi/viff-devel-viff.dk
