.. batch_crop documentation master file, created by
   sphinx-quickstart on Thu Sep  6 20:07:45 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

======================================
Welcome to batch_crop's documentation!
======================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules
   units
   contributing

``batch_crop`` is a Python utility for cropping lots of images at once and
uniformly. This is the developer documentation. If you are just interested in
using ``batch_crop``, see the README at the root of the repository. This project
is hosted on GitHub at https://github.com/U8NWXD/batch_crop.

Getting Started
===============

#. Install Python 3.6

#. Clone repository:

   .. code-block:: console

      $ git clone https://github.com/U8NWXD/batch_crop

#. Install requirements:

   .. code-block:: console

      $ pip install -r requirements.txt

#. Run:

   .. code-block:: console

      python batch_crop.py

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`