First MVP of documentation improvement with this changes:

- Minified README
- Added user documentation in sphinx format
- Updated gitignore for Idea IDEs and for sphinx docs

.gitignore

@@ -6,7 +6,7 @@
 *.dylib
 /qed
 
-# Autogenerated code 
+# Autogenerated code
 tests/plot.hmtl
 tests/report.bin
 cover.html
@@ -17,7 +17,7 @@ tests/cloud/aws/to_upload/rendered
 tests/results
 c-deps/libs
 
-# Documents 
+# Documents
 *.pdf
 TODO.md
 
@@ -28,7 +28,11 @@ TODO.md
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# User Documentation builds
+rtd_docs/build/
+
 # Custom editor or IDE project settings
+.idea
 .vscode
 .vs
 coverage.txt

README.rst

@@ -0,0 +1,60 @@
+********************************************************************
+Q.E.D. - Scalable, auditable and high-performance tamper-evident log
+********************************************************************
+
+.. image:: https://qed.org/projects/apicheck/badge/?version=latest
+   :target: https://qed.readthedocs.io
+   :alt: User Documentation Status
+.. image:: https://gdiazlo.visualstudio.com/qed/_apis/build/status/BBVA.qed?branchName=master
+   :target: https://github.com/BBVA/masquerade/blob/master/LICENSE
+   :alt: Build Status
+.. image:: https://img.shields.io/azure-devops/coverage/gdiazlo/qed/1/master.svg
+   :target: https://gdiazlo.visualstudio.com/qed/_build/latest?definitionId=1&branchName=master
+   :alt: Azure DevOps coverage
+.. image:: https://goreportcard.com/badge/github.com/bbva/qed
+   :target: https://goreportcard.com/report/github.com/bbva/qed
+   :alt: GoReport
+.. image:: https://godoc.org/github.com/bbva/qed?status.svg
+   :target: https://godoc.org/github.com/bbva/qed
+   :alt: GoDoc
+
+.. figure:: https://raw.githubusercontent.com/BBVA/qed/master/rtd_docs/source/_static/images/qed_logo_small.png
+   :align: center
+
+What's Q.E.D.
+-------------
+
+``Q.E.D.`` is an open-source software that allows you to establish **trust relations with others**. It can be used in multiple scenarios: **secure tamper-evident data transfers**, **tamper-evident** (system/application/business) **logging**, etc.
+
+``Q.E.D.`` **guarantees** that the system itself, even when deployed **into a non-trusted server**, cannot be modified without being detected. It also **provides verifiable cryptographic proofs** in logarithmic relation (time and size) to the number of entries.
+
+Why Q.E.D.
+----------
+
+``Q.E.D.`` is **scalable**, **resilient** and **ops friendly**:
+
+- Designed to manage **billions of events** per shard
+- Over **2000 operations per second** per shard under sustained load
+- Consistent replication through RAFT
+- Operable and instrumented with dozens of metrics
+- **Zero config files**, fully documented single binary
+
+Documentation
+-------------
+
+You can find the complete documentation at: `Documentation <https://qed.readthedocs.io>`_
+
+Authors
+-------
+
+``Q.E.D.`` was made by Hyperscale BBVA-Labs Team.
+
+License
+-------
+
+``Q.E.D.`` is Open Source and available under the `Apache 2 license <https://github.com/BBVA/qed/blob/master/LICENSE>`_.
+
+Contributions
+-------------
+
+Contributions are very welcome. See `CONTRIBUTING.md <https://github.com/BBVA/qed/blob/master/CONTRIBUTING.md>`_ or skim `existing tickets <https://github.com/BBVA/qed/issues>`_ to see where you could help out.

rtd_docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

rtd_docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

rtd_docs/requirements-doc.txt

@@ -0,0 +1,2 @@
+Sphinx
+sphinx_rtd_theme

rtd_docs/source/conf.py

@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'QED'
+copyright = '2019, BBVA-Labs Team'
+author = 'BBVA-Labs Team'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+master_doc = "index"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+html_show_sourcelink = True
+html_logo = "_static/images/qed_logo_small.png"
+html_theme_options = {
+    'collapse_navigation': False,
+    'logo_only': False,
+    'display_version': True,
+    'style_nav_header_background': 'white',
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']