egami/doc/mainpage.md

EGAMI library                                {#mainpage}
=============

@tableofcontents

What is EGAMI:                               {#egami_mainpage_what}
==============

EGAMI, or IMAGE in the oposity way is a simple library that permit to read many format of image without knolege of the specific under library API.

What it does:                               {#egami_mainpage_what_it_does}
-------------

EGAMI Read some image format:
  - bmp
  - png
  - svg

Egami stor file format:
  - bmp

EGAMI is dependent of the STL (compatible with MacOs stl (CXX))

What is the TODO list:                       {#egami_mainpage_todo}
----------------------

Must integrate read of:
  - jpeg
  - webp
  - gif
  - tga
  - yuv

Must integrate store of:
  - png
  - webp

must port to use Open-cv core backend to store image (in optionnal mode)


What languages are supported?                    {#egami_mainpage_language}
=============================

EGAMI is written in C++.


Are there any licensing restrictions?            {#egami_mainpage_license_restriction}
=====================================

EGAMI is **FREE software** and _all sub-library are FREE and staticly linkable !!!_


License (MPL v2.0)                               {#egami_mainpage_license}
==================

Copyright EGAMI Edouard DUPIN

Licensed under the Mozilla Public License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

<https://www.mozilla.org/MPL/2.0>

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


Other pages                              {#egami_mainpage_sub_page}
===========

  - @ref egami_build
  - @ref egami_tutorial_read
  - @ref egami_tutorial_write
  - [**ewol coding style**](http://atria-soft.github.io/ewol/ewol_coding_style.html)