From 5033fc5c5822bf663ad4e9768d8a4addd294ba75 Mon Sep 17 00:00:00 2001 From: Christopher Koerber Date: Mon, 8 Nov 2021 10:20:49 +0100 Subject: [PATCH] Added docs Badge and referred to doc --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 62f3526..cd1ef85 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Documentation Status](https://readthedocs.org/projects/lsqfitgui/badge/?version=latest)](https://lsqfitgui.readthedocs.io/en/latest/?badge=latest) # Lsqfit GUI Graphical user interface for `lsqfit` using `dash`. @@ -6,9 +7,10 @@ Graphical user interface for `lsqfit` using `dash`. ## Install -Run +Run the following commands in the repository root directory ``` -pip install [-e] . +pip install --upgrade numpy scipy +pip install [--user] [-e] . ``` ## Usage @@ -44,14 +46,7 @@ lsqfitgui [--function other_script.py:fcn] fit.p Both commands will spawn a local server hosting the lsqfit interface. -## Advanced configuration - -It is possible to also set up fit meta information, i.e., allowing different fit models. See also the `example` directory for more details. - -The following script spawns the server which generated the above image -```bash -python example/entrypoint.py -``` +For more information, see also [the documentation](https://lsqfitgui.readthedocs.io/en/latest/). ## Tests