Skip to content
README.rst 3.99 KiB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. -*- Mode: rst -*-

.. -*- Mode: rst -*-

..
Fabrice Salvaire's avatar
Fabrice Salvaire committed
   |PatroUrl|
   |PatroHomePage|_
   |PatroDoc|_
   |Patro@github|_
   |Patro@readthedocs|_
   |Patro@readthedocs-badge|
   |Patro@pypi|_
Fabrice Salvaire's avatar
Fabrice Salvaire committed

.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
   :target: https://www.openhub.net/accounts/fabricesalvaire
   :alt: Fabrice Salvaire's Ohloh profile
   :height: 15px
   :width:  80px

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |PatroUrl| replace:: http://fabricesalvaire.github.io/Patro
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |PatroHomePage| replace:: Patro Home Page
.. _PatroHomePage: http://fabricesalvaire.github.io/Patro
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |PatroDoc| replace:: Patro Documentation
.. _PatroDoc: http://pyvalentina.readthedocs.org/en/latest
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Patro@readthedocs-badge| image:: https://readthedocs.org/projects/pyvalentina/badge/?version=latest
Fabrice Salvaire's avatar
Fabrice Salvaire committed
   :target: http://pyvalentina.readthedocs.org/en/latest

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Patro@github| replace:: https://github.com/FabriceSalvaire/Patro
.. .. _Patro@github: https://github.com/FabriceSalvaire/Patro
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Patro@readthedocs| replace:: http://pyvalentina.readthedocs.org
.. .. _Patro@readthedocs: http://pyvalentina.readthedocs.org
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Patro@pypi| replace:: https://pypi.python.org/pypi/Patro
.. .. _Patro@pypi: https://pypi.python.org/pypi/Patro
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/Patro.svg?branch=master
   :target: https://travis-ci.org/FabriceSalvaire/Patro
   :alt: Patro build status @travis-ci.org
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Pypi Download| image:: https://img.shields.io/pypi/dm/Patro.svg
   :target: https://pypi.python.org/pypi/Patro
   :alt: Patro Download per month
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Pypi Version| image:: https://img.shields.io/pypi/v/Patro.svg
   :target: https://pypi.python.org/pypi/Patro
   :alt: Patro last version
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Pypi License| image:: https://img.shields.io/pypi/l/Patro.svg
   :target: https://pypi.python.org/pypi/Patro
   :alt: Patro license
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Pypi Format| image:: https://img.shields.io/pypi/format/Patro.svg
   :target: https://pypi.python.org/pypi/Patro
   :alt: Patro format
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/Patro.svg
   :target: https://pypi.python.org/pypi/Patro
   :alt: Patro python version
Fabrice Salvaire's avatar
Fabrice Salvaire committed

..  coverage test
..  https://img.shields.io/pypi/status/Django.svg
..  https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star
.. -*- Mode: rst -*-

.. |Python| replace:: Python
.. _Python: http://python.org

.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi

.. |Numpy| replace:: Numpy
.. _Numpy: http://www.numpy.org

.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org

Fabrice Salvaire's avatar
Fabrice Salvaire committed
=======
 Patro
=======
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
|Pypi License|
|Pypi Python Version|
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
|Pypi Version|
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/Patro/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/Patro/tree/devel>`_
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Overview
========
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
What is Patro ?
---------------

Patro is a Python module which implements pattern drafting for fashion design.

Where is the Documentation ?
----------------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
The documentation is available on the |PatroHomePage|_.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
What are the main features ?
----------------------------

.. -*- Mode: rst -*-

The features of Patro are :
Fabrice Salvaire's avatar
Fabrice Salvaire committed

* read/write *.val* and *.vit* file
* `QMuParser <http://beltoforion.de/article.php?a=muparser>`_ expressions are translated to Python and evaluated on the fly
* API to define patterns
* compute the detail of a pattern
* export the detail to latex/pgf as A0 or tiled A4 paper

Missing features:

* full operation support
* direct PDF export
* SVG export

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. image:: https://raw.github.com/FabriceSalvaire/Patro/master/test/output/pattern-a0.png
Fabrice Salvaire's avatar
Fabrice Salvaire committed
 :height: 600px

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. image:: https://raw.github.com/FabriceSalvaire/Patro/master/test/output/pattern-a4.png
Fabrice Salvaire's avatar
Fabrice Salvaire committed
 :height: 600px
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
How to install it ?
-------------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Look at the `installation <https://fabricesalvaire.github.io/PyValentina/installation.html>`_ section in the documentation.
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Credits
=======
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Authors: `Fabrice Salvaire <http://fabrice-salvaire.fr>`_
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
News
====
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. -*- Mode: rst -*-

Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
.. no title here
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
V0 2017-02-16
-------------
Fabrice Salvaire's avatar
Fabrice Salvaire committed

Fabrice Salvaire's avatar
Fabrice Salvaire committed
Started project