Commit Graph

6 Commits

Author SHA1 Message Date
Jean Sirmai f3564d0462
docs/rtfm/manual WIP: redaction
a version of the same text with lines length limited to 80 char is available
2024-11-20 17:59:09 +01:00
Jean Sirmai 56acc696b6
docs/rtfm/intro writing + cleaning details in src/ 2024-11-20 17:59:09 +01:00
Jean Sirmai 2a739928fb
rtfm/intro (writing the manual) + cleaning doc 2024-11-20 17:59:09 +01:00
Jean Sirmai 98f69581b8
rtfm/intro Manual Introduction - a first version.
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.
2024-11-20 17:54:16 +01:00
Jean Sirmai 6e72f1f392
src/fsm/control.c fsm_init() and fsm_close() can be now triggered from main().
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.
2024-11-20 17:54:16 +01:00
Jean Sirmai 1676f36674
docs/*: integrate doxygen, create a documentation zone, adds notes
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
2024-11-20 17:54:06 +01:00