]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/gil/README.md
projects / ceph.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
import quincy beta 17.1.0
[ceph.git] / ceph / src / boost / libs / gil / README.md
CommitLineData
92f5a8d4
TL		 1![Boost Generic Image Library (GIL)](https://raw.githubusercontent.com/boostorg/gil/develop/doc/_static/gil.png)
2
3[![Language](https://img.shields.io/badge/C%2B%2B-11-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
4[![License](https://img.shields.io/badge/license-BSL-blue.svg)](https://opensource.org/licenses/BSL-1.0)
5[![Documentation](https://img.shields.io/badge/gil-documentation-blue.svg)](http://boostorg.github.com/gil/)
6[![Wiki](https://img.shields.io/badge/gil-wiki-blue.svg)](https://github.com/boostorg/gil/wiki)
7[![Mailing List](https://img.shields.io/badge/gil-mailing%20list-4eb899.svg)](https://lists.boost.org/mailman/listinfo.cgi/boost-gil)
8[![Gitter](https://img.shields.io/badge/gil-chat%20on%20gitter-4eb899.svg)](https://gitter.im/boostorg/gil)
9[![Try it online](https://img.shields.io/badge/on-wandbox-blue.svg)](https://wandbox.org/permlink/isNgnMuqWcqTqzy7)
10[![Conan](https://img.shields.io/badge/on-conan-blue.svg)](https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters)
11[![Vcpkg](https://img.shields.io/badge/on-vcpkg-blue.svg)](https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil)
12
13Documentation | AppVeyor | Azure Pipelines | Travis CI | CircleCI | Regression
14--------------|-----------------|-----------------|-----------------|-----------------|------------
20effc67
TL		 15[![develop](https://img.shields.io/badge/doc-develop-blue.svg)](https://boostorg.github.io/gil/develop/) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h/branch/develop?svg=true)](https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop) | [![Azure](https://dev.azure.com/boostorg/gil/_apis/build/status/boostorg.gil?branchName=develop)](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=7&branchName=develop) | [![Travis](https://travis-ci.org/boostorg/gil.svg?branch=develop)](https://travis-ci.org/boostorg/gil) | [![CircleCI](https://circleci.com/gh/boostorg/gil/tree/develop.svg?style=shield)](https://circleci.com/gh/boostorg/workflows/gil/tree/develop) | [![gil](https://img.shields.io/badge/gil-develop-blue.svg)](http://www.boost.org/development/tests/develop/developer/gil.html)
16[![master](https://img.shields.io/badge/doc-master-blue.svg)](https://boostorg.github.io/gil/) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h?svg=true)](https://ci.appveyor.com/project/stefanseefeld/gil/branch/master) | [![Azure](https://dev.azure.com/boostorg/gil/_apis/build/status/boostorg.gil?branchName=master)](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=7&branchName=master) | [![Travis](https://travis-ci.org/boostorg/gil.svg?branch=master)](https://travis-ci.org/boostorg/gil) | [![CircleCI](https://circleci.com/gh/boostorg/gil/tree/master.svg?style=shield)](https://circleci.com/gh/boostorg/workflows/gil/tree/master) | [![gil](https://img.shields.io/badge/gil-master-blue.svg)](http://www.boost.org/development/tests/master/developer/gil.html)
f67539c2 17
92f5a8d4
TL		 18# Boost.GIL
19
20- [Introduction](#introduction)
21- [Documentation](#documentation)
22- [Requirements](#requirements)
23- [Branches](#branches)
24- [Community](#community)
25- [Contributing](#contributing-we-need-your-help)
26- [License](#license)
27
28## Introduction
29
30Boost.GIL is a part of the [Boost C++ Libraries](http://github.com/boostorg).
31
f67539c2 32The Boost Generic Image Library (GIL) is a **C++11** library that abstracts image
92f5a8d4
TL		 33representations from algorithms and allows writing code that can work on a
34variety of images with performance similar to hand-writing for a specific image type.
35
36## Documentation
37
38- [Latest release](https://boost.org/libs/gil)
39- [Branch master](http://boostorg.github.io/gil/) (latest release with minor changes)
40- [Branch develop](http://boostorg.github.io/gil/develop/)
41
42See [RELEASES.md](RELEASES.md) for release notes.
43
44See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions about how to build and
f67539c2
TL		 45run tests and examples using Boost.Build or CMake.
46
47See [example/README.md](example/README.md) for GIL usage examples.
48
49See [example/b2/README.md](example/b2/README.md) for Boost.Build configuration examples.
92f5a8d4 50
f67539c2 51See [example/cmake/README.md](example/cmake/README.md) for CMake configuration examples.
92f5a8d4
TL		 52
53## Requirements
54
55**NOTE:** The library source code is currently being modernized for C++11.
56
57The Boost Generic Image Library (GIL) requires:
58
59- C++11 compiler (GCC 4.9, clang 3.3, MSVC++ 14.0 (1900) or any later version)
60- Boost header-only libraries
61
62Optionally, in order to build and run tests and examples:
63
64- Boost.Filesystem
65- Boost.Test
f67539c2 66- Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension and some of examples.
92f5a8d4
TL		 67
68## Branches
69
70The official repository contains the following branches:
71
72- [**master**](https://github.com/boostorg/gil/tree/master) This
73 holds the most recent snapshot with code that is known to be stable.
74
75- [**develop**](https://github.com/boostorg/gil/tree/develop) This
76 holds the most recent snapshot. It may contain unstable code.
77
78## Community
79
80There is number of communication channels to ask questions and discuss Boost.GIL issues:
81
f67539c2
TL		 82- Mailing lists ([Boost discussion policy](https://www.boost.org/more/discussion_policy.html))
83 - [boost-gil](https://lists.boost.org/mailman/listinfo.cgi/boost-gil) (*recommended*) official Boost.GIL mailing list ([archive](https://lists.boost.org/boost-gil/))
84 - [boost-users](https://lists.boost.org/mailman/listinfo.cgi/boost-users) for all Boost users
85 - [boost](https://lists.boost.org/mailman/listinfo.cgi/boost) for all Boost developers
86- Slack at [cpplang.slack.com](https://cppalliance.org/slack/) with Boost channels:
87 - [\#boost-gil](https://cpplang.slack.com/archives/CSVT0STV2) (*recommended*) official Boost.GIL channel
88 - [\#boost-user](https://cpplang.slack.com/messages/CEWTCFDN0/) for all Boost users
89 - [\#boost](https://cpplang.slack.com/messages/C27KZLB0X/) for all Boost developers
90- Gitter room [boostorg/gil](https://gitter.im/boostorg/gil) (old real-time chat space)
92f5a8d4
TL		 91- You can also ask questions via GitHub issue.
92
93## Contributing (We Need Your Help!)
94
95If you would like to contribute to Boost.GIL, help us improve the library
96and maintain high quality, there is number of ways to do it.
97
98If you would like to test the library, contribute new feature or a bug fix,
99see the [CONTRIBUTING.md](CONTRIBUTING.md) where the whole development
100infrastructure and the contributing workflow is explained in details.
101
102You may consider performing code reviews on active
103[pull requests](https://github.com/boostorg/gil/pulls) or help
104with solving reported issues, especially those labelled with:
105
106- [status/need-help](https://github.com/boostorg/gil/labels/status%2Fneed-help)
107- [status/need-feedback](https://github.com/boostorg/gil/labels/status%2Fneed-feedback)
108- [need-minimal-example](https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example)
109
110Any feedback from users and developers, even simple questions about how things work
111or why they were done a certain way, carries value and can be used to improve the library.
112
113## License
114
115Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).
Ceph