Commit 386d5733 authored by Pierre Augier's avatar Pierre Augier
Browse files

Add badges in README

parent fcc75e9ac4ea
FluidPythran: Pythran annotations in Python files
=================================================
|release| |coverage|
.. |release| image:: https://img.shields.io/pypi/v/fluidpythran.svg
:target: https://pypi.python.org/pypi/fluidpythran/
:alt: Latest version
.. |coverage| image:: https://codecov.io/bb/fluiddyn/fluidpythran/branch/default/graph/badge.svg
:target: https://codecov.io/bb/fluiddyn/fluidpythran/branch/default/
:alt: Code coverage
.. warning ::
This is really just a prototype. See `this post
......@@ -10,7 +21,8 @@ FluidPythran: Pythran annotations in Python files
for an explanation of my motivations.
This pure-Python package will provide few supplementary pythran commands,
namely ``pythran block`` and ``pythran def`` (see examples in the doc folder).
namely :code:`pythran block` and :code:`pythran def` (see examples in the doc
folder).
The code of the numerical kernels can stay in the modules and in the classes
where they were written. The Pythran files (i.e. the files compiled by
......@@ -18,3 +30,18 @@ Pythran), which are usually written by the user, are produced automatically.
The code continues to work fine without Pythran, which is used only when
available.
Installation
------------
.. code ::
pip install fluidpythran
License
-------
FluidDyn is distributed under the CeCILL-B_ License, a BSD compatible
french license.
.. _CeCILL-B: http://www.cecill.info/index.en.html
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment