Here is a small tutorial on how to generate the new (WIP) reference pages, for testing.
This requires several steps. The instructions below should work for any Linux distribution, as well as MSYS2 for Windows users.
The CLI tool
gmic of G’MIC is used to generate the pages, so make sure it is already installed and available from your executable
- Clone the git repo of the G’MIC project and activate the
$ cd gmic
$ git checkout develop
- Go to the
html folder, and create an empty test directory where all the generated files will be put.
$ cd gmic/html
$ mkdir test_ref
$ cd test_ref
- Generate all the images for the reference documentation (beware, this takes some time!).
$ mkdir img
$ cd img # Go to 'gmic/html/test_ref/img/'
$ gmic up parse_cli images
- Generate the HTML files of the documentation (one file per command).
$ cd .. # Go back to 'gmic/html/test_ref/'
$ gmic parse_cli html
- Open your web browser, and go to URL :
You should be able then to browse the doc.
Note that this is still work in progress. Any feedback welcome. I’ve recently learnt how CSS works, and I’ve not used it a lot in the doc. This is gonna be improved in the future.