add README.md

hema-ted · Feb 19, 2020 · fb4296d · fb4296d
1 parent dc6297b
commit fb4296d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+## **PyZFS** code repository
+
+**PyZFS** a Python package for first-principles calculations of the spin-spin zero-field-splitting (ZFS) tensor based on wavefunctions obtained from density functional theory (DFT) calculations.
+
+The tutorial and documentation are hosted on [Read the Docs](https://pyzfs-doc.readthedocs.io/en/latest/).
+