add section 'Contributing' and README.md

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>

README.md

@@ -0,0 +1,7 @@
+# F4PGA
+
+This is the entrypoint to the documentation of F4PGA.
+
+- [f4pga.readthedocs.io](https://f4pga.readthedocs.io)
+- [f4pga.readthedocs.io/projects/arch-defs](https://f4pga.readthedocs.io/projects/arch-defs)
+- [f4pga-examples.readthedocs.io](https://f4pga-examples.readthedocs.io)

docs/contributing/building-docs.rst

@@ -0,0 +1,15 @@
+Building the documentation
+##########################
+
+Activate the virtual environment and install dependencies::
+
+    make env
+    make enter
+
+Build the whole documentation::
+
+    make html
+
+For more options see::
+
+    make help

docs/contributing/venv.rst

@@ -1,25 +1,5 @@
-===============
-Getting Started
-===============
-
-Building documentation
-----------------------
-
-Activate the virtual environment and install dependencies::
-
-    make env
-    make enter
-
-Build the whole documentation::
-
-    make html
-
-For more options see::
-
-    make help
-
 Packages in virtual environment
--------------------------------
+###############################
 
 To install packages in conda environment you can use both
 ``conda`` and ``pip``.

docs/index.rst

@@ -2,7 +2,6 @@ F4PGA documentation
 ###################
 
 .. toctree::
-   :maxdepth: 3
 
    introduction
    toolchain-desc/index
@@ -10,3 +9,9 @@ F4PGA documentation
    Project X-Ray ➚ <https://f4pga.readthedocs.io/projects/prjxray/en/latest/>
    Project Trellis ➚ <https://prjtrellis.readthedocs.io/en/latest/>
    FPGA Assembly (FASM) ➚ <https://fasm.readthedocs.io/en/latest/>
+
+.. toctree::
+   :caption: Contributing
+
+   contributing/building-docs
+   contributing/venv