mirror of
https://github.com/boostorg/gil.git
synced 2026-02-24 04:02:11 +00:00
5f94cd18de
Basic structure and some paragraphs stolen from https://github.com/boostorg/beast/ - a great README example. Fixes #166
96 lines
5.0 KiB
Markdown
96 lines
5.0 KiB
Markdown
|
|
|
|
[](http://www.boost.org/LICENSE_1_0.txt)
|
|
[](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)
|
|
|
|
Branch | Travis (gcc/clang) | AppVeyor (VS2017) | CircleCI (gcc/clang) | Regression
|
|
------------|--------------------|-------------------|----------------------|-----------
|
|
**develop** | [](https://travis-ci.org/boostorg/gil) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop) | [](https://circleci.com/gh/boostorg/workflows/gil/tree/develop) | [](http://www.boost.org/development/tests/develop/developer/gil.html)
|
|
**master** | [](https://travis-ci.org/boostorg/gil) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/master) | [](https://circleci.com/gh/boostorg/workflows/gil/tree/master) | [](http://www.boost.org/development/tests/master/developer/gil.html)
|
|
|
|
# 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++ 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
|
|
- Development: http://boostorg.github.io/gil/
|
|
|
|
## Requirements
|
|
|
|
**NOTE:** The library source code is currently being modernized for C++11.
|
|
|
|
The Boost Generic Image Library (GIL) requires:
|
|
|
|
- C++11 compiler
|
|
- Boost header-only libraries
|
|
|
|
Optionally, in order to [build and run tests](#contributing-we-need-your-help) and examples
|
|
|
|
- Boost.Filesystem
|
|
- Boost.Test
|
|
|
|
## 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:
|
|
|
|
- Mailing list [boost-gil](https://lists.boost.org/mailman/listinfo.cgi/boost-gil) ([archive](https://lists.boost.org/boost-gil/)) as well as official Boost lists, [boost-users](https://lists.boost.org/mailman/listinfo.cgi/boost-users) and
|
|
[boost](https://lists.boost.org/mailman/listinfo.cgi/boost).
|
|
- Gitter chat room [boostorg//gil](https://gitter.im/boostorg/gil).
|
|
- [cpplang.slack.com](https://cpplang.slack.com) chat room [#boost](https://cpplang.slack.com/messages/C27KZLB0X/).
|
|
- IRC channel [#boost](irc://chat.freenode.net/#osgeo-geos) on FreeNode.
|
|
- 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](https://github.com/boostorg/gil/blob/develop/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).
|