aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorMiodrag Milanović <mmicko@gmail.com>2024-12-11 13:07:00 +0100
committerGitHub <noreply@github.com>2024-12-11 13:07:00 +0100
commit461ba9dce938791089e2d1b15c297110f3374bc2 (patch)
tree4ba160c75cedb609531ba63457b53fb60adbe3b0 /docs/README.md
parent738af822905fdcf0466e9dd784b9ae4b0b34987f (diff)
parentafb459ae2acc6b969dc5fcae3431f59ae134f8fa (diff)
Merge pull request #341 from YosysHQ/docs
Convert documentation to readthedocs
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
+```