File: README.rst

package info (click to toggle)
python-aafigure 0.6-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 428 kB
  • sloc: python: 1,942; makefile: 112
file content (46 lines) | stat: -rw-r--r-- 1,334 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
================================
 aafigure |build-status| |docs|
================================

aafigure is an ASCII art to image converter.::

    DD o--->

ASCII art figures can be parsed and output as SVG, PNG, JPEG, PDF and more.
This project provides a Python_ package, a command line script as well as
Docutils and MoinMoin plugins.

The project is registered in PyPi:
    http://pypi.python.org/pypi/aafigure

The project is managed in Launchpad (Answers, Bug Tracking and Code)
    https://github.com/aafigure/aafigure

License:
    Simplified BSD License, see LICENSE.txt


Documentation
=============
A manual can be found in the documentation directory. The .rst files can
be looked at with a text editor or they can be compiled to HTML or PDF
using Sphinx_.


Installation
============
Detailed instructions about different install methods are described in the
file documentation/manual.rst.

Short version::

    python -m pip install aafigure

.. _Python: http://python.org/
.. _Sphinx: http://sphinx-doc.org/
.. |build-status| image:: https://travis-ci.org/aafigure/aafigure.svg?branch=master
   :target: https://travis-ci.org/aafigure/aafigure
   :alt: Build status
.. |docs| image:: https://readthedocs.org/projects/aafigure/badge/?version=latest
   :target: http://aafigure.readthedocs.io/
   :alt: Documentation