readme: add introduction

mrcmry · Nov 16, 2022 · acd2a38 · acd2a38
1 parent b108f74
commit acd2a38
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -2,6 +2,16 @@
 SpinalDoc
 =========
 
+This is the documentation repository for
+`SpinalHDL <https://github.com/SpinalHDL/SpinalHDL>`_.
+
+It is published on
+`spinalhdl.github.io/SpinalDoc-RTD <https://spinalhdl.github.io/SpinalDoc-RTD/master/index.html>`_.
+
+You can also find the API documentation on
+`spinalhdl.github.io/SpinalHDL <https://spinalhdl.github.io/SpinalHDL/dev/spinal/index.html>`_.
+
+
 How to build this documentation
 ===============================