Skip to content

Commit 42f8687

Browse files
authored
Merge pull request #46 from pshriwise/update_readme
Updates to README for the latest installation method.
2 parents 6849029 + 19196f4 commit 42f8687

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,25 @@ repository](https://github.com/landonjmitchell/openmc-plotgui)).
1111

1212
OpenMC, Matplotlib, NumPy, PySide2
1313

14+
## Installation
15+
16+
This package is most easily installed by running
17+
18+
```console
19+
pip install .
20+
```
21+
22+
from the top directory in the repository.
23+
1424
## Usage
1525

1626
From a directory containing a working OpenMC model run:
1727

1828
```console
19-
python /path/to/openmc-plotter
29+
openmc-plotter
2030
```
2131

22-
Press `?` to view a variety of keyboard shortcuts.
32+
Once the viewer has opened, press `?` to view a variety of keyboard shortcuts.
2333

2434
# Controls/Functionality
2535

0 commit comments

Comments
 (0)