Metadata-Version: 2.0
Name: Devoir
Version: 0.1.1
Summary: Quickly set up a working environment to edit a file.
Home-page: https://git.framasoft.org/spalax/devoir
Author: Louis Paternault
Author-email: spalax@gresille.org
License: GPLv3 or any later version
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Utilities

Devoir — Quickly set up a working environment to edit a file
============================================================

|sources| |pypi| |documentation| |license|

When editing a LaTeX file, I want the file being edited with `vim
<http://www.vim.org>`_, the compiled file displayed using a pdf viewer, and
latex being run whenever something changes, using `latexmk
<http://users.phys.psu.edu/~collins/software/latexmk-jcc/>`_. But wait, there
is more.

- I often start a LaTeX document by copying an existing one, as a template.
- The pdf file may or may not exist when I start working: if I have already
  been working on this file before, the pdf file exists; if not, it does not
  exists, and my pdf viewer won't start on a non-existing file.

This program aims to automate all this process. I built it to process LaTeX
files, but it should work with other files too.

What's new?
-----------

See `changelog
<https://git.framasoft.org/spalax/devoir/blob/master/CHANGELOG>`_.

Download and install
--------------------

See the end of list for a (quick and dirty) Debian package.

* From sources:

  * Download: https://pypi.python.org/pypi/devoir
  * Install (in a `virtualenv`, if you do not want to mess with your distribution installation system)::

        python3 setup.py install

* From pip::

    pip install devoir

* Quick and dirty Debian (and Ubuntu?) package

  This requires `stdeb <https://github.com/astraw/stdeb>`_ to be installed::

      python3 setup.py --command-packages=stdeb.command bdist_deb
      sudo dpkg -i deb_dist/devoir-<VERSION>_all.deb

Documentation
-------------

* The compiled documentation is available on `readthedocs
  <http://devoir.readthedocs.org>`_

* To compile it from source, download and run::

      cd doc && make html


.. |documentation| image:: http://readthedocs.org/projects/devoir/badge
  :target: http://devoir.readthedocs.org
.. |pypi| image:: https://img.shields.io/pypi/v/devoir.svg
  :target: http://pypi.python.org/pypi/devoir
.. |license| image:: https://img.shields.io/pypi/l/devoir.svg
  :target: http://www.gnu.org/licenses/gpl-3.0.html
.. |sources| image:: https://img.shields.io/badge/sources-devoir-brightgreen.svg
  :target: http://git.framasoft.org/spalax/devoir


