--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

                        _____   _   __  __ _____ _____
                       / ____| | | |  \/  |_   _/ ____|
                      | |  __  |_| | \  / | | || |
                      | | |_ |     | |\/| | | || |
                      | |__| |     | |  | |_| || |____
                       \_____|     |_|  |_|_____\_____|

                      GREYC's Magic for Image Computing

                             ( https://gmic.eu )

                                    4.0.1

--------------------------------------------------------------------------------

# In a Nutshell
#---------------

 G'MIC is a full-featured open-source framework for digital image processing,
 distributed under the CeCILL free software licenses (LGPL-like and/or
 GPL-compatible).
 It provides several user interfaces for converting, processing, and visualizing
 generic image datasets, ranging from 1D scalar signals to 3D+t sequences of
 multi-spectral volumetric images, which naturally include 2D color images.

 G'MIC user interfaces are:

 1 - 'gmic', a command-line tool for using G'MIC's image processing features
     from a shell. In this context, G'MIC can be viewed as a friendly companion
     to the ImageMagick or GraphicsMagick software suites.

 2 - 'libgmic', a small, portable, thread-safe and multi-threaded C++ image
     processing library designed to be linked with third-party applications.
     Its simple API allows developers to integrate all G'MIC features into their
     own software without much effort (a C API is available as well).

 3 - 'G'MIC-Qt', a plug-in designed to bring G'MIC's capabilities to image
     editing and painting applications like GIMP, Krita, Photoshop,
     Affinity Photo, PaintShop Pro, PhotoLine and Paint.NET.
     More than 600 filters are already available, sorted by category
     (Artistic, Black & white, Colors, Contours, Deformations, Degradations,
     Details, Film emulation, Frames, Layers, Light & shadows, Patterns,
     Rendering, Repair, Sequences, etc.).

 4 - G'MIC Online, a web service that lets users apply image processing
     algorithms to their images, directly from a web browser.

 5 - 'ZArt', a Qt-based interface for real-time processing of video streams from
     webcams or video files.

 G'MIC is an open framework: its default scripting language can be extended with
 custom G'MIC-written commands, adding new image filters and effects to the
 language. Furthermore, it already contains a substantial set of pre-defined
 image processing algorithms and pipelines (more than 1000).

 G'MIC has been designed with portability in mind, and runs on various
 platforms (Windows, Linux, BSD, macOS).
 Since 2008, it has been developed by the Image Team of the GREYC laboratory in
 Caen, France, by tenured researchers working in the field of image processing
 on a daily basis.

# Project Managers and Main Developers
#-------------------------------------

  David Tschumperlé  ( https://tschumperle.users.greyc.fr/ )

  A complete list of contributors is available on the project web page:

                         https://gmic.eu

# Institution
#-------------

 GREYC Image / CNRS UMR 6072 / FRANCE

 Team web page: https://www.greyc.fr/image

# License
#---------

 The C++ source code of G'MIC is distributed partly under the CeCILL-C v.1.0
 (LGPL-like) and CeCILL v.2.1 (GPL-compatible) licenses (see file 'COPYING').
 These licenses ( https://cecill.info/index.en.html ) were created
 under the supervision of the three largest research institutions on
 computer science in France:

   - CNRS  ( https://www.cnrs.fr/ )
   - CEA   ( https://www.cea.fr/ )
   - INRIA ( https://www.inria.fr/ )

# Testing the Software
#----------------------

You can verify that G'MIC is working correctly by running these two commands,
which execute all the commands and filters available in the framework:

$ gmic input_text 'https://gmic.eu/gmic_stdlib.$_version' parse_cli images

and

$ gmic input_text 'https://gmic.eu/gmic_stdlib.$_version' parse_gui images

Please make sure you run these commands in an empty folder, as they generate a
lot of new image files.

# Referencing the Software
#--------------------------

To cite G'MIC in your own publications, please cite the JOSS article,
published in January 2025:

  - D. Tschumperlé, S. Fourey and G. Osgood (2025).
    "G'MIC: An Open-Source Self-Extending Framework for Image Processing",
    Journal of Open Source Software, 10(105), 6618,
    https://doi.org/10.21105/joss.06618

  - Corresponding BibTeX entry:

@article{Tschumperlé2025,
  doi = {10.21105/joss.06618},
  url = {https://doi.org/10.21105/joss.06618},
  year = {2025},
  publisher = {The Open Journal},
  volume = {10},
  number = {105},
  pages = {6618},
  author = {David Tschumperlé and Sébastien Fourey and Garry Osgood},
  title = {G'MIC: An Open-Source Self-Extending Framework for Image Processing},
  journal = {Journal of Open Source Software}
}

# More Information Online
#-------------------------

  - Home page: https://gmic.eu
  - Download page: https://gmic.eu/download
  - Tutorial page: https://gmic.eu/tutorial/
  - Reference documentation: https://gmic.eu/reference
  - G'MIC Online: https://gmicol.greyc.fr
  - Discussion forum: https://discuss.pixls.us/c/software/gmic
  - Mastodon: https://piaille.fr/@gmic
  - BlueSky: https://bsky.app/profile/gmic-eu.bsky.social
  - X: https://x.com/gmic_eu
  - GimpChat forum: https://gimpchat.com/viewforum.php?f=28

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------