Documentation and packaging

[roelj]

User guide

To make it easier to use the program a user guide would be quite useful. @xuv: Would you be interested in helping out with this?

Developer documentation

I've taken better care of documenting the code to create a reference guide. I used doxygen to make a nice overview which can be viewed here: roelj.com/inklingreader.

Packaging

I experimented with debian packaging and I think I can provide a self-signed Debian package. I wonder if anyone has any experience with packaging..

[xuv]

Sure. I'd be happy to help write the user guide. You pointed me to Texinfo. But I haven't taken the time to look into that. And I've never done any Latex. Maybe I could start by writting plain text.

[roelj]

Plain text is a good idea. Maybe this Texinfo reference card will get you up to speed: Texinfo reference card

Most text is actually "plain text". To create a heading or show examples in a fixed-width font you can use a special syntax:

@code{./inklingreader}

Or when it's multiple lines:

@example 
autoreconf -i
./configure
make
@end example

Creating headings can be done this way:

@chapter A chapter name (1. )
@section A section in the chapter (1.1)
@subsection A subsection in a section (1.1.1)
@subsubsection A subsection in a subsection (1.1.1.1)

I think this is almost everything you'll need :-).

[xuv]

Thx :)