From: Greg Davill <greg.davill@gmail.com>
Date: Sun, 19 Apr 2020 04:10:03 +0000 (+0930)
Subject: add readme
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=eb22a108f982d966bd301a5e10f6f38cf3a59369;p=ecpprog.git

add readme
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e4b5ffa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# ecpprog
+
+A basic driver for FTDI based JTAG probes, to program ECP5 FPGAs.
+
+## Features:
+ - Flash programing via JTAG link to ECP5 part.
+ - Validate ECP5 IDCODEs
+ - Read/Decode ECP5 status register
+
+## Prerequisites
+
+```
+sudo apt-get install libftdi-dev
+```
+
+## Building
+
+```
+git clone https://github.com/gregdavill/ecpprog ecpprog
+cd ecpprog/ecpprog
+make
+sudo make install
+```
\ No newline at end of file