This commit creates docs/rtfm/gem-graph.texi, which from now on will be the
Gem-graph manual source code.
Its first text includes just an introduction, the beginning of a chapter namely
"Gem-graph by example" and a first cross-reference to the section "Hello world".
To display this minimal window, three files and two functions must be
added simultaneously:
- include/widget/h
- src/manager.c
- src/main_window/design.c
main() now contains: g_signal_connect (on_windows_activation);
on_windows_activation () is in src/manager.c and calls
widget_main_window () which is in src/main_window/design.c
NB The iconic image of E coli drawn by David S. Goodsell in 2009
is reproduced here with permission.
One goal of Gem-graph is to animate such static representations
i.e. use the best anatomy to try to achieve good physiology.
The same text is presented in two formats: for an external text editor (.txt)
or with lines limited to 80 characters.
The links are prepared but not functionnal.
These two functions (defined in control.c) initiate the log and print it just
before the end of the program.
It is now possible to send messages that reports the events occuring during a
session: the creation of the log, then of the application and their closure in
the reverse order.
As previously,there is no g signal connect (activate) and no window is created.
This triggers the same error message in the console.
What is new, in this commit, is that a first log is printed in the console.
We wanted to have an automated documentation for our project. We choose doxygen
since this is a well-established project, with common standards.
To generate the documentation, simply type `make docs` and open `docs/html/index.html`.
The documentation zone actually contains:
- archives: several files from past of the projects, historical purpose
- GTK-docs: ressources on GTK internals and API
- rtfm: first draft of a user manual
- showcase: some pictures of the UI example, that were communicated on the Gem-graph discussion room (XMPP)
- html: doxygen-generated docs
Jean Sirmai