README
======

.. Start ignoring LineLengthBear

::

                                                         .o88Oo._
                                                        d8P         .ooOO8bo._
                                                        88                  '*Y8bo.
                                          __            YA                      '*Y8b   __
                                        ,dPYb,           YA                        68o68**8Oo.
                                        IP'`Yb            "8D                       *"'    "Y8o
                                        I8  8I             Y8     'YB                       .8D
                                        I8  8P             '8               d8'             8D
                                        I8  8'              8       d8888b          d      AY
         ,gggo,    ,ggggo,    ,gggo,gg  I8 dP    ,gggo,gg   Y,     d888888         d'  _.oP"
        dP"  "Yb  dP"  "Y8go*8P"  "Y8I  I8dP    dP"  "Y8I    q.    Y8888P'        d8
       i8'       i8'    ,8P i8'    ,8I  I8P    i8'    ,8I     "q.  `Y88P'       d8"
      ,d8,_    _,d8,   ,d8' d8,   ,d8b,,d8b,_ ,d8,   ,d8b,       Y           ,o8P
    ooP""Y8888PP*"Y8888P"   "Y8888P"`Y88P'"Y88P"Y8888P"`Y8            oooo888P"

.. Stop ignoring LineLengthBear

INSTALLATION
============

coala-bears can be installed with ``pip3 install coala-bears``. If you need more
information about the installation and dependencies, take a look at our
`installation documentation
<http://coala.rtfd.org/en/latest/Users/Install.html>`__.

The latest code from master is automatically deployed to PyPI as a
development version. Get it with ``pip3 install coala-bears --pre``.

|PyPI|

USAGE
=====

If you want to learn more about coala-bears, its functionality and its usage,
please take a look at our
`tutorial <http://coala.readthedocs.org/en/latest/Users/Tutorials/Writing_Bears.html#what-is-a-bear>`__.

ABOUT
=====

coala-bears is a Python package containing all the bears that is used by coala.

Read more at our `documentation <http://coala.readthedocs.org/en/latest/Users/Tutorials/Writing_Bears.html#guide-to-write-a-bear>`__.

Authors
-------

coala-bears is maintained by a growing community. Please take a look at the
meta information in `setup.py <setup.py>`__ for current maintainers.

Project Status
--------------

|Linux Build Status| |Windows Build status| |OSX Build status|

|Documentation Status| |codecov.io|

GETTING INVOLVED
================

If you want to contribute to coala-bears, please take a look at the `Getting
Involved Information
<http://coala.readthedocs.org/en/latest/Getting_Involved/README.html>`__.

We appreciate any help!

|https://gitter.im/coala-analyzer/coala|

LICENSE
=======

|AGPL|

This code falls under the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

Please note that some files or content may be copied from other places.
Most of them are GPL compatible. There is a small portion of code in the
tests that falls under the Creative Commons license, see
https://creativecommons.org/licenses/by-sa/3.0/deed.de for more
information.

.. |PyPI| image:: https://img.shields.io/pypi/v/coala-bears.svg
   :target: https://pypi.python.org/pypi/coala-bears
.. |Linux Build Status| image:: https://img.shields.io/circleci/project/coala-analyzer/coala-bears/master.svg?label=linux%20build
   :target: https://circleci.com/gh/coala-analyzer/coala-bears
.. |Windows Build status| image:: https://img.shields.io/appveyor/ci/coala/coala-bears/master.svg?label=windows%20build
   :target: https://ci.appveyor.com/project/coala/coala-bears/branch/master
.. |OSX Build status| image:: https://img.shields.io/travis/coala-analyzer/coala-bears/master.svg?label=osx%20build
   :target: https://travis-ci.org/coala-analyzer/coala-bears
.. |Documentation Status| image:: https://readthedocs.org/projects/coala/badge/?version=latest
   :target: http://coala.rtfd.org/
.. |codecov.io| image:: https://img.shields.io/codecov/c/github/coala-analyzer/coala-bears/master.svg?label=branch%20coverage
   :target: https://codecov.io/github/coala-analyzer/coala-bears
.. |https://gitter.im/coala-analyzer/coala| image:: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg
   :target: https://gitter.im/coala-analyzer/coala
.. |AGPL| image:: https://img.shields.io/github/license/coala-analyzer/coala-bears.svg
   :target: https://www.gnu.org/licenses/agpl-3.0.html
