New Developer Guidelines

skyjake

<i>This post was originally made by <b>skyjake</b> on the dengDevs blog. It was posted under the category: Documentation.</i>

DEW should be utilized more heavily in documenting all aspects of Doomsday. For example, I propose that the ChangeLog.txt is discontinued and moved to the wiki. I've written a new <a href="http://dengine.net/dew/index.php?title=Developer_guidelines">Developer guidelines</a> page.

Yagisan

OK. Changelogs should be locked down so only the devs can edit it. I will still need to recreate as a .txt file to keep the many *NIX distros happy, as well as an in tarball COMPILING.txt.

I am happy to update the wiki documentation as I get time.

skyjake

<blockquote> I will still need to recreate [the changelog] as a .txt file</blockquote> The "Printable version" of the wiki's Version history page, or some filtered copy thereof, should be helpful/do the trick?

As far the COMPILING goes, I'd like to see that information in the wiki as well. Could a similar procedure be used to create the distributed copies of the file?

Yagisan

Possibly. I shall play around with bash, wget and lynx to see if I can make a script to scape the wiki when I roll the tarballs.

skyjake

I copied the content of COMPILING to the wiki, as <a href="http://dengine.net/dew/index.php?title=Compilation_with_Cmake&quot; rel="nofollow">Compilation with CMake</a>. The relevant portions of the Linux README file were included as <a href="http://dengine.net/dew/index.php?title=Running_Doomsday_in_Unix&quot; rel="nofollow">Running Doomsday in Unix</a>.

It would be great if it were possible to use these versions in the tarballs as well, since maintaining a duplicate of the information is rarely a good idea.

skyjake

Maybe this would be satisfactory for generating the distributed text-only versions of the docs:
http://www.sagehill.net/docbookxsl/FormattedText.html

Yagisan

Looks useful. I will update the wiki building/running instructions as I get time.