From f252cdcafec669e192c20d590ee7bf6b9270a256 Mon Sep 17 00:00:00 2001
From: Marco Kuhlen <kuhlenmarco@gmail.com>
Date: Fri, 25 Oct 2019 15:23:15 +0200
Subject: [PATCH] adds brief description

---
 README.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a32b8a0..ab95839 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
 # Solarmod-code
 
-Semi-analytical model for solar modulation in two dimensions.
\ No newline at end of file
+Semi-analytical model for solar modulation in two dimensions.
+
+A minimal test script is shown in test.py in python and test.cpp in c++.  In
+both cases the local interstellar spectrum is loaded from a file, the spectrum
+is modulated using the parametrisation presented in arXiv:1909.01154 and given
+scale factors g1 and g2 and then write the modulated spectrum to a file.
-- 
GitLab