Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 71 lines (45 sloc) 1.917 kb
d3f965b Colomban Wendling GeanyGenDoc: Update README.in, add HACKING
b4n authored
1 GeanyGenDoc
2 ===========
3
4 .. contents::
5
6
7 About
8 =====
9
10 GeanyGenDoc is a plugin for Geany that aims to help code documentation by
11 automatically generating documentation comment basis from the source code.
b158f33 Colomban Wendling Import GeanyGenDoc into geany-plugins
b4n authored
12
13
14 Requirements
15 ============
16
17 You will need the following packages to build GeanyGenDoc:
d3f965b Colomban Wendling GeanyGenDoc: Update README.in, add HACKING
b4n authored
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)
10a19f0 Colomban Wendling Fix CTPL dependency in the README (we depends on 0.3 since revision 1645...
b4n authored
23 * CTPL >= 0.3 (http://ctpl.tuxfamily.org/)
d3f965b Colomban Wendling GeanyGenDoc: Update README.in, add HACKING
b4n authored
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/)
b158f33 Colomban Wendling Import GeanyGenDoc into geany-plugins
b4n authored
27
28 You may also want the following packages that enables extra features:
d3f965b Colomban Wendling GeanyGenDoc: Update README.in, add HACKING
b4n authored
29
30 * Docutils (http://docutils.sourceforge.net/) -- or another implementation of
31 rst2html -- is needed to (re)generate the HTML manual.
b158f33 Colomban Wendling Import GeanyGenDoc into geany-plugins
b4n authored
32
33
d3f965b Colomban Wendling GeanyGenDoc: Update README.in, add HACKING
b4n authored
34 Usage
35 =====
36
37 For more details about GeanyGenDoc, see the user manual that can be found in
38 the docs/ subirectory or opened with the menu item `Tools → Documentation
39 Generator → Open Manual` from the Geany window if you already runs GeanyGenDoc.
40
41
42 Hacking
43 =======
44
45 See the HACKING file for information on how to get started on hacking
46 GeanyGenDoc internals.
47
48
49 License
50 =======
51
52 GeanyGenDoc is distributed under the terms of the GNU General Public License
53 as published by the Free Software Foundation, either version 3 of the
54 License, or (at your option) any later version. You should have received a copy
55 of the GNU General Public License along with GeanyGenDoc. If not, see
56 <http://www.gnu.org/licenses/>.
57
58
59 Contact
60 =======
61
62 You 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
66 Bug reports and feature requests
67 --------------------------------
68
69 To report a bug or ask for a new feature, please use the Geany-Plugins tracker
70 on SourceForge: http://sourceforge.net/tracker/?group_id=222729
Something went wrong with that request. Please try again.