Some minor docstring/readme updates

lethe/LATEST
Jan Petykiewicz 4 years ago
parent b5a7c9a7ad
commit 58b4f4a40f

@ -26,12 +26,12 @@
Install with pip from PyPi (preferred):
```bash
pip install fatamorgana
pip3 install fatamorgana
```
Install directly from git repository:
```bash
pip install git+https://mpxd.net/code/jan/fatamorgana.git@release
pip3 install git+https://mpxd.net/code/jan/fatamorgana.git@release
```
## Documentation

@ -16,7 +16,13 @@
Dependencies:
- Python 3.5 or later
- numpy (optional, no additional functionality)
- numpy (optional, faster but no additional functionality)
To get started, try:
```python3
import fatamorgana
help(fatamorgana.OasisLayout)
```
"""
import pathlib

Loading…
Cancel
Save