Merge pull request #24 from ORNL-Fusion/readme_fix

Readme fix
ORNL-Fusion · Dec 30, 2024 · 9e262f2 · 9e262f2
2 parents e3dbb73 + c9366d5
commit 9e262f2
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
-# BMW
+# BMW
+Biot-Savart Magnetic Vmec Vector potential.
+
+## Building
+This is a subproject of the [Stellarator-Tools](https://github.com/ORNL-Fusion/Stellarator-Tools) suite of codes. To build the code follow the instructions in the [Stellarator-Tools](https://github.com/ORNL-Fusion/Stellarator-Tools) repository.