From 776ec784ff1cbb440eb5225c4e685976ddffa132 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jean-Fran=C3=A7ois=20Nguyen?= <jf@jfng.fr>
Date: Fri, 1 Apr 2022 19:16:07 +0200
Subject: [PATCH] Add very basic README.

---
 README.md                 | 18 ++++++++++++++++++
 cores/microwatt/README.md | 14 +++++++-------
 2 files changed, 25 insertions(+), 7 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..298e003
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# power-fv
+
+(TODO)
+
+## Prerequisites
+
+- Python 3.8+
+- [Yosys](https://github.com/YosysHQ/yosys)
+- [SymbiYosys (sby)](https://github.com/YosysHQ/sby)
+
+## Installation
+
+```python3
+pip3 install poetry --user
+poetry install
+```
+
+See the `cores` folder for usage examples.
diff --git a/cores/microwatt/README.md b/cores/microwatt/README.md
index 88425c8..462ddb9 100644
--- a/cores/microwatt/README.md
+++ b/cores/microwatt/README.md
@@ -1,11 +1,11 @@
-Requirements:
-- amaranth
-- yosys
-- ghdl
-- ghdl-yosys-plugin
-- sby
+## Additional prerequisites
+
+- [ghdl](https://github.com/ghdl/ghdl) with the LLVM or GCC backend
+- [ghdl-yosys-plugin](https://github.com/ghdl/ghdl-yosys-plugin)
+
+## Usage
 
 ```shell
 git clone https://github.com/antonblanchard/microwatt
-python run.py
+poetry run python ./run.py
 ```