Add readme

streamlit · Jun 21, 2024 · 7245e6d · 7245e6d
1 parent 7eecbd1
commit 7245e6d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# 🌀 Spiral template
+
+A simple Streamlit app that draws a spiral. 
+
+[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://basic-template.streamlit.app/)
+
+### How to run it on your own machine
+
+1. Install the requirements
+
+   ```
+   $ pip install -r requirements.txt
+   ```
+
+2. Run the app
+
+   ```
+   $ streamlit run streamlit_app.py
+   ```