Skip to content

Commit 61697df

Browse files
authored
Update README.md
1 parent 769746d commit 61697df

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ metadata. The main advantages of this approach are:
3434

3535
## Usage
3636

37+
For full details, please consult the [wiki page](https://github.com/rizac/stream2segment/wiki)
38+
3739
Stream2segment is a Python library and command line application available
3840
after installation via the command `s2s` on the terminal. By typing `s2s --help` you
3941
will see all available subcommands for downloading
@@ -95,12 +97,12 @@ In a nutshell:
9597
python paramtable.py ...
9698
```
9799
98-
2. `gui.py`: visualize downloaded data in the user browser via the plots defined in the module:
100+
2. `gui.py`: visualize downloaded data in the user browser via the plots defined in the module (an example in the figure above):
99101
```console
100102
s2s show -d download.yaml -p gui.py -c gui.yaml ...
101103
```
102-
(Type `s2s show --help` for details)
103-
104+
(Type `s2s show --help` for details).
105+
104106
> **Note**: the associated YAML files (`paramtable.yaml`, `gui.yaml`) are not
105107
mandatory but enforce the good practice of separating configuration settings (YAML)
106108
and the actual Python code. This way you can experiment

0 commit comments

Comments
 (0)