document the gitbranch template
[ikiwiki] / doc / examples / softwaresite.mdwn
1 This is an [[example_software_package_website|index]].
2 Just copy the softwaresite subdirectory into your wiki to quickly produce
3 a website for a piece of software.
4
5 Some additional configuration you might want to do:
6
7 * Make sure to configure ikiwiki to generate RSS or Atom feeds.
8
9 * The softwaresite/doc subdirectory is intended to hold docs about your
10   software package. These docs can be included in the package itself;
11   there is a [[softwaresite/Makefile]] that will use ikiwiki to build
12   static html documentation. ikiwiki itself uses a similar system to build
13   its documentation.
14
15 * Read the [[tips/integrated_issue_tracking_with_ikiwiki]] article for tips
16   about how to use ikiwiki as a BTS.
17
18 * Read [[tips/spam_and_softwaresites]] for information on how to keep spam
19   and spam-fighting commits out of your main version control history.