From ab99ce69e53c13ce1be6a2dd492960c1b840f3de Mon Sep 17 00:00:00 2001
From: Tamas Gal <tgal@km3net.de>
Date: Wed, 26 Feb 2020 12:50:02 +0100
Subject: [PATCH] Update readme
---
README.rst | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/README.rst b/README.rst
index b1f0d2b..8c3c4da 100644
--- a/README.rst
+++ b/README.rst
@@ -10,22 +10,30 @@ The jppy Python package
.. image:: https://examples.pages.km3net.de/km3badges/docs-latest-brightgreen.svg
:target: https://km3py.pages.km3net.de/jppy
-This software provides access to the PDF functionalities in Jpp. It depends on
-some Jpp headers (no Jpp compilation needed) and on the ROOT ``TMath`` (a
-compiled ROOT installation is needed).
+This software provides Python access to functionalities in Jpp, like accesing
+PDF functions.
+
+It currently depends on a few Jpp headers (no Jpp compilation needed) and on
+ROOT ``TMath`` (a compiled ROOT installation is needed).
+
+**Note:** Beware that this package is WIP!
-**Note:** Beware that this package is in the development phase, so the API will
-change until version ``1.0.0`` is released!
Installation
============
-Run ``make`` to compile the Python modules::
+The package can be installed via ``pip`` directly from the Git repository::
+
+ pip install git+https://git.km3net.de/km3py/jppy
+
+or from a local clone::
+
+ git clone https://git.km3net.de/km3py/jppy
+ pip install jppy/
- make
-Example
-=======
+Example - Using PDFs
+====================
Here is an example how to play around with muon PDFs using the ``jppy`` module::
--
GitLab