aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2020-12-28 00:02:13 +0100
committerPatrick Lehmann <Patrick.Lehmann@plc2.de>2020-12-28 00:02:13 +0100
commit06a089b3e1500e9e362212e5d1af80e203bff089 (patch)
tree2f2d44951a9b7095bccd5c5116606ca2971d0446 /pyGHDL
parent0235203f927367e96e9486fff5d2cf4ed089223c (diff)
downloadghdl-06a089b3e1500e9e362212e5d1af80e203bff089.tar.gz
ghdl-06a089b3e1500e9e362212e5d1af80e203bff089.tar.bz2
ghdl-06a089b3e1500e9e362212e5d1af80e203bff089.zip
Added a minimal README for pyGHDL.
Diffstat (limited to 'pyGHDL')
-rw-r--r--pyGHDL/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/pyGHDL/README.md b/pyGHDL/README.md
new file mode 100644
index 000000000..deb45b8d8
--- /dev/null
+++ b/pyGHDL/README.md
@@ -0,0 +1,12 @@
+# pyGHDL
+
+Python binding for GHDL and high-level APIs.
+
+## Provided Packages
+
+* `pyGHDL.libghdl` - Low-level Python bindings to GHDL's `libghdl` shared library.
+ Auto generated API from Ada sources.
+* `pyGHDL.cli` - Command line interface tools.
+* `pyGHDL.lsp` - Language Server Protocol (LSP) implementation for VHDL.
+* `pyGHDL.dom` - Document Object Model (DOM) for VHDL parsed by `libghdl`.
+* `pyGHDL.xtools` - *tbd*