aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorMiodrag Milanovic <mmicko@gmail.com>2024-11-29 09:04:06 +0100
committerMiodrag Milanovic <mmicko@gmail.com>2024-11-29 09:04:06 +0100
commit42be8d5bf0c2c6f3422b14cc4d264da7781da43b (patch)
treea9692b6c12f964859df2143704750c9877bd33b6 /docs/README.md
parent738af822905fdcf0466e9dd784b9ae4b0b34987f (diff)
Start converting documentation to Sphinx
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..853712b
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,11 @@
+Project Icestorm Documentation
+===================================
+
+Setting up environment
+----------------------
+
+```
+python -m venv .venv
+source .venv/bin/activate
+make reqs
+```