From b5ace50d9dba66a143c61b1673897f9010e52025 Mon Sep 17 00:00:00 2001 From: Alex Hadley Date: Tue, 11 Apr 2023 13:17:43 -0700 Subject: [PATCH] Update README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9e1fe93..ca1d615 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,16 @@ pip install -U paramview \ The `extra-index-url` parameters are needed since ParamView and ParamDB are not published to PyPI yet. If you are using a Python package manager, add `https://painterqubits.github.io/paramview/releases` and -`https://painterqubits.github.io/paramdb/releases` as secondary sources. For example, -for [Poetry] the commands are: +`https://painterqubits.github.io/paramdb/releases` as secondary sources before installing. +For example, for [Poetry] the commands are: ``` poetry source add --secondary paramview https://painterqubits.github.io/paramview/releases poetry source add --secondary paramdb https://painterqubits.github.io/paramdb/releases ``` +Then ParamView and ParamDB can be added like any other package. + ## Usage To launch the ParamView GUI, run: @@ -32,3 +34,5 @@ paramview ``` For more options, run `paramview --help`. + +[poetry]: https://python-poetry.org