README
1GeanyGenDoc
2===========
3
4.. contents::
5
6
7About
8=====
9
10GeanyGenDoc is a plugin for Geany that aims to help code documentation by
11automatically generating documentation comment basis from the source code.
12
13
14Requirements
15============
16
17You will need the following packages to build GeanyGenDoc:
18
19* Geany >= 0.19 (http://www.geany.org/)
20* GTK+ >= 2.12 (http://www.gtk.org)
21* GLib >= 2.14 (http://www.gtk.org)
22* GIO >= 2.18 (http://www.gtk.org)
23* CTPL >= 0.3 (http://ctpl.tuxfamily.org/)
24* A working C compiler (GCC for example, http://gcc.gnu.org/)
25* A working make implementation (GNU make is recommended,
26 http://www.gnu.org/software/make/)
27
28You may also want the following package that enables extra features:
29
30* Docutils (http://docutils.sourceforge.net/) -- or another implementation of
31 rst2html -- is needed to (re)generate the HTML manual.
32
33
34Usage
35=====
36
37For more details about GeanyGenDoc, see the user manual that can be found in
38the docs/ subdirectory or opened with the menu item `Tools → Documentation
39Generator → Open Manual` from the Geany window if you already run GeanyGenDoc.
40
41
42Hacking
43=======
44
45See the HACKING file for information on how to get started on hacking
46GeanyGenDoc internals.
47
48
49License
50=======
51
52GeanyGenDoc is distributed under the terms of the GNU General Public License
53as published by the Free Software Foundation, either version 3 of the
54License, or (at your option) any later version. You should have received a copy
55of the GNU General Public License along with GeanyGenDoc. If not, see
56<http://www.gnu.org/licenses/>.
57
58
59Contact
60=======
61
62You can mail me at <ban(at)herbesfolles(dot)org>, and I may also be on the
63#geany channel on FreeNode, under the `b4n` nickname.
64
65
66Bug reports and feature requests
67--------------------------------
68
69To report a bug or ask for a new feature, please use the Geany-Plugins tracker
70on GitHub: https://github.com/geany/geany-plugins/issues
71