From: Sebastien Bourdeauducq <sb@m-labs.hk>
Date: Mon, 24 Jun 2019 02:00:31 +0000 (+0800)
Subject: README: add clarification about HLS
X-Git-Tag: locally_working~152
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=67c06b4540b5687fee3ded8c5bf43a84a32201a3;p=nmigen.git

README: add clarification about HLS
---

diff --git a/README.md b/README.md
index 3b4e07d..79b55c3 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,10 @@ Thanks [LambdaConcept][] for being a sponsor of this project! Contact sb [at] m-
 [yosys]: http://www.clifford.at/yosys/
 [lambdaconcept]: http://lambdaconcept.com/
 
+### HLS?
+
+nMigen is *not* a "Python-to-FPGA" conventional high level synthesis (HLS) tool. It will *not* take a Python program as input and generate a hardware implementation of it. In nMigen, the Python program is executed by a regular Python interpreter, and it emits explicit statements in the FHDL domain-specific language.  Writing a conventional HLS tool that uses nMigen as an internal component might be a good idea, on the other hand :)
+
 ### Installation
 
     pip install git+https://github.com/m-labs/nmigen.git