< Previous by Date Date Index Next by Date >
< Previous in Thread Thread Index  

[reSIProcate] documentation



Here is what there is in the wiki (and there is more, too):

http://www.resiprocate.org/AutotoolsBuild
- was for the old autotools build, updated for the new build

http://www.resiprocate.org/Quick_Subversion_Checkout_and_Compilation_HOWTO

http://www.resiprocate.org/Configuration_and_Building_a_stack

http://www.resiprocate.org/Configuration_Options

http://www.resiprocate.org/Pocket_PC_Build

http://www.resiprocate.org/The_reSIProcate_build_system

and even things like this:

   http://www.resiprocate.org/Using_Repro

have a section on installation/compilation.



and there are various things in different parts of SVN, at the top
level, and in some individual projects:

https://svn.resiprocate.org/viewsvn/resiprocate/main/INSTALL?view=markup

https://svn.resiprocate.org/viewsvn/resiprocate/main/RELEASE-PROCESS.txt?view=markup


Just picking through all the wikis and updating them for autotools may
not be the most efficient approach, and may not give the best long term
results.

I think it would be good to decide on a documentation strategy.  It
might actually be optimal to have something within the repo, but with
some kind of markup (not just text files), and whatever it is, to
eliminate duplication, as duplication increases the probability of
something not remaining up to date over time.

I've seen people using things like asciidoc, docbook and LaTex.  Is
there anything like that that is particularly appealing?