mirror of
https://github.com/boostorg/gil.git
synced 2026-01-19 16:22:14 +00:00
115 lines
6.7 KiB
Markdown
115 lines
6.7 KiB
Markdown
|
|
|
|
[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
|
|
[](https://opensource.org/licenses/BSL-1.0)
|
|
[](http://boostorg.github.com/gil/)
|
|
[](https://github.com/boostorg/gil/wiki)
|
|
[](https://lists.boost.org/mailman/listinfo.cgi/boost-gil)
|
|
[](https://gitter.im/boostorg/gil)
|
|
[](https://wandbox.org/permlink/isNgnMuqWcqTqzy7)
|
|
[](https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters)
|
|
[](https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil)
|
|
|
|
Documentation | GitHub Actions | AppVeyor | Regression | Codecov
|
|
--------------|----------------|----------|------------|----------
|
|
[](https://boostorg.github.io/gil/develop/) | [](https://github.com/boostorg/gil/actions?query=branch:develop) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop) | [](https://regression.boost.io/develop/developer/gil.html) | [](https://app.codecov.io/gh/boostorg/gil/branch/develop)
|
|
[](https://boostorg.github.io/gil/) | [](https://github.com/boostorg/gil/actions?query=branch:master) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/master) | [](https://regression.boost.io/master/developer/gil.html) | [](https://app.codecov.io/gh/boostorg/gil/branch/master)
|
|
|
|
# Boost.GIL
|
|
|
|
- [Introduction](#introduction)
|
|
- [Documentation](#documentation)
|
|
- [Requirements](#requirements)
|
|
- [Branches](#branches)
|
|
- [Community](#community)
|
|
- [Contributing](#contributing-we-need-your-help)
|
|
- [License](#license)
|
|
|
|
## Introduction
|
|
|
|
Boost.GIL is a part of the [Boost C++ Libraries](http://github.com/boostorg).
|
|
|
|
The Boost Generic Image Library (GIL) is a **C++14** header-only library that abstracts image
|
|
representations from algorithms and allows writing code that can work on a
|
|
variety of images with performance similar to hand-writing for a specific image type.
|
|
|
|
## Documentation
|
|
|
|
- [Latest release](https://boost.org/libs/gil)
|
|
- [Branch master](http://boostorg.github.io/gil/) (latest release with minor changes)
|
|
- [Branch develop](http://boostorg.github.io/gil/develop/)
|
|
|
|
See [RELEASES.md](RELEASES.md) for release notes.
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions about how to build and
|
|
run tests and examples using Boost.Build or CMake.
|
|
|
|
See [example/README.md](example/README.md) for GIL usage examples.
|
|
|
|
See [example/b2/README.md](example/b2/README.md) for Boost.Build configuration examples.
|
|
|
|
See [example/cmake/README.md](example/cmake/README.md) for CMake configuration examples.
|
|
|
|
## Requirements
|
|
|
|
The Boost Generic Image Library (GIL) requires:
|
|
|
|
- C++14 compiler (GCC 6, clang 3.9, MSVC++ 14.1 (1910) or any later version)
|
|
- Boost header-only libraries
|
|
|
|
Optionally, in order to build and run tests and examples:
|
|
|
|
- Boost.Filesystem
|
|
- Boost.Test
|
|
- Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension and some of examples.
|
|
|
|
## Branches
|
|
|
|
The official repository contains the following branches:
|
|
|
|
- [**master**](https://github.com/boostorg/gil/tree/master) This
|
|
holds the most recent snapshot with code that is known to be stable.
|
|
|
|
- [**develop**](https://github.com/boostorg/gil/tree/develop) This
|
|
holds the most recent snapshot. It may contain unstable code.
|
|
|
|
## Community
|
|
|
|
There is number of communication channels to ask questions and discuss Boost.GIL issues:
|
|
|
|
- [GitHub Discussions](https://github.com/boostorg/gil/discussions/)
|
|
- Mailing lists ([Boost discussion policy](https://www.boost.org/more/discussion_policy.html))
|
|
- [boost-gil](https://lists.boost.org/mailman/listinfo.cgi/boost-gil) (*recommended*) official Boost.GIL mailing list ([archive](https://lists.boost.org/boost-gil/))
|
|
- [boost-users](https://lists.boost.org/mailman/listinfo.cgi/boost-users) for all Boost users
|
|
- [boost](https://lists.boost.org/mailman/listinfo.cgi/boost) for all Boost developers
|
|
- Slack at [cpplang.slack.com](https://cppalliance.org/slack/) with Boost channels:
|
|
- [\#boost-gil](https://cpplang.slack.com/archives/CSVT0STV2) (*recommended*) official Boost.GIL channel
|
|
- [\#boost-user](https://cpplang.slack.com/messages/CEWTCFDN0/) for all Boost users
|
|
- [\#boost](https://cpplang.slack.com/messages/C27KZLB0X/) for all Boost developers
|
|
- Gitter room [boostorg/gil](https://gitter.im/boostorg/gil) (old real-time chat space)
|
|
- You can also ask questions via GitHub issue.
|
|
|
|
## Contributing (We Need Your Help!)
|
|
|
|
If you would like to contribute to Boost.GIL, help us improve the library
|
|
and maintain high quality, there is number of ways to do it.
|
|
|
|
If you would like to test the library, contribute new feature or a bug fix,
|
|
see the [CONTRIBUTING.md](CONTRIBUTING.md) where the whole development
|
|
infrastructure and the contributing workflow is explained in details.
|
|
|
|
You may consider performing code reviews on active
|
|
[pull requests](https://github.com/boostorg/gil/pulls) or help
|
|
with solving reported issues, especially those labelled with:
|
|
|
|
- [status/need-help](https://github.com/boostorg/gil/labels/status%2Fneed-help)
|
|
- [status/need-feedback](https://github.com/boostorg/gil/labels/status%2Fneed-feedback)
|
|
- [need-minimal-example](https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example)
|
|
|
|
Any feedback from users and developers, even simple questions about how things work
|
|
or why they were done a certain way, carries value and can be used to improve the library.
|
|
|
|
## License
|
|
|
|
Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).
|