Help Writing Reference Documentation
You can help writing reference documentation pages for the G'MIC project.
Additional documentation pages are found in the gmic-community
, available at:
Imagine you want to add a new section, named Tips and Tricks
Create a new file Tips and Tricks.gmd
in folder reference/
), and write its content, following the syntax defined in G'MIC Markdown
Step 2: Check that your contribution is rendered correctly in HTML. For that, you'll need gmic, the CLI tool of G'MIC.
$ gmic it "Tips and Tricks.gmd" gmd2html ot out.html
This renders a new HTML file out.html
of which you can check the rendering (with a web browser).
When everything looks fine, just commit your change (or open a pull request
if you don't have writing access to the gmic-community
G'MIC is an open-source software distributed under the
CeCILL free software licenses (LGPL-like and/or
Copyrights (C) Since July 2008,
David Tschumperlé - GREYC UMR CNRS 6072, Image Team.