Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Hadley committed Apr 11, 2023
1 parent 1979d8e commit b5ace50
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -32,3 +34,5 @@ paramview <path to ParamDB database file>
```

For more options, run `paramview --help`.

[poetry]: https://python-poetry.org

0 comments on commit b5ace50

Please sign in to comment.