On 03/10/2010 01:52 PM, Martin Paljak wrote: > On Mar 10, 2010, at 12:28 , Andreas Jellinghaus wrote: >> so what is your plan for the other project? I still think each >> project needs to have some minimal user/developer documentation >> shipped with them in the tar.gz, so it is available in the >> distributions. do you agree? how should that documentation be >> written and maintained, if you implement your plan with the new >> trac/wiki? I proposed docbook (or some other format) with source >> code of the documentation inside the svn, but I don't remember you >> commenting on that. > User documentation in the package should be 1. README file 2. man > pages. Evertyhing else should be online. Developer documentation, if > any, should be a doxygen API description. > > A versioned README/INSTALL file is the easiest in many cases. > Guides, tutorials, howtos are best left to the web.
I also think that static wiki pages in release tarballs don't make much sense. I always go to the project's web page and look up info from there. By all means, if you need to rip out all the static wiki pages from release tarballs to better structure the web page, go for it. They don't really add much value. Release tarballs need the following documentation: - man pages - License file (COPYING) - File with instructions how to compile the code what you need to compile it (README) - NEWS/ChangeLog -- Kalev _______________________________________________ opensc-devel mailing list [email protected] http://www.opensc-project.org/mailman/listinfo/opensc-devel
