Some minor docstring/readme updates

2020-04-17 13:51:43 -07:00 · 2020-04-17 13:51:43 -07:00 · 58b4f4a40f
commit 58b4f4a40f
parent b5a7c9a7ad
2 changed files with 12 additions and 6 deletions
--- a/fatamorgana/init.py
+++ b/fatamorgana/init.py
@ -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