From 622e542bb2420235067731cff4bd8824e2041e8a Mon Sep 17 00:00:00 2001
From: Stavros Sachtouris <saxtouri@admin.grnet.gr>
Date: Tue, 25 Aug 2015 16:01:59 +0300
Subject: [PATCH] Initialize user_guide, write install/setup section

---
 docs/user_guide/Makefile                   | 177 +++++++++++
 docs/user_guide/source/cli.rst             |   2 +
 docs/user_guide/source/conf.py             | 354 +++++++++++++++++++++
 docs/user_guide/source/gui.rst             |   2 +
 docs/user_guide/source/index.rst           |  42 +++
 docs/user_guide/source/settings.rst        |   2 +
 docs/user_guide/source/setup.rst           | 145 +++++++++
 docs/user_guide/source/troubleshooting.rst |   2 +
 8 files changed, 726 insertions(+)
 create mode 100644 docs/user_guide/Makefile
 create mode 100644 docs/user_guide/source/cli.rst
 create mode 100644 docs/user_guide/source/conf.py
 create mode 100644 docs/user_guide/source/gui.rst
 create mode 100644 docs/user_guide/source/index.rst
 create mode 100644 docs/user_guide/source/settings.rst
 create mode 100644 docs/user_guide/source/setup.rst
 create mode 100644 docs/user_guide/source/troubleshooting.rst

diff --git a/docs/user_guide/Makefile b/docs/user_guide/Makefile
new file mode 100644
index 0000000..60bfab2
--- /dev/null
+++ b/docs/user_guide/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Agkyra.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Agkyra.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Agkyra"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Agkyra"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/user_guide/source/cli.rst b/docs/user_guide/source/cli.rst
new file mode 100644
index 0000000..06c9eeb
--- /dev/null
+++ b/docs/user_guide/source/cli.rst
@@ -0,0 +1,2 @@
+Command Line Interface (CLI)
+============================
\ No newline at end of file
diff --git a/docs/user_guide/source/conf.py b/docs/user_guide/source/conf.py
new file mode 100644
index 0000000..6585a00
--- /dev/null
+++ b/docs/user_guide/source/conf.py
@@ -0,0 +1,354 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2015 GRNET S.A.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Agkyra documentation build configuration file, created by
+# sphinx-quickstart on Tue Aug 25 12:52:58 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# 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.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Agkyra'
+copyright = u'2015, Synnefo development team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%d %B %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- 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 = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Agkyradoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+# 'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+# 'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#' preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'Agkyra.tex', u'Agkyra Documentation',
+   u'Synnefo development team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'agkyra', u'Agkyra Documentation',
+     [u'Synnefo development team'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Agkyra', u'Agkyra Documentation',
+   u'Synnefo development team', 'Agkyra', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Agkyra'
+epub_author = u'Synnefo development team'
+epub_publisher = u'Synnefo development team'
+epub_copyright = u'2015, Synnefo development team'
+
+# The basename for the epub file. It defaults to the project name.
+# epub_basename = u'Agkyra'
+
+# The HTML theme for the epub output. Since the default themes are not optimized
+# for small screen space, using the same theme for HTML and epub output is
+# usually not wise. This defaults to 'epub', a theme designed to save visual
+# space.
+# epub_theme = 'epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+# epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+# epub_identifier = ''
+
+# A unique identification for the text.
+# epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+# epub_cover = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+# epub_guide = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#e pub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+# epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+# epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+# epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+# epub_tocscope = 'default'
+
+# Fix unsupported image types using the PIL.
+# epub_fix_images = False
+
+# Scale large images.
+# pub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# epub_show_urls = 'inline'
+
+# If false, no index is generated.
+# epub_use_index = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/docs/user_guide/source/gui.rst b/docs/user_guide/source/gui.rst
new file mode 100644
index 0000000..d81118d
--- /dev/null
+++ b/docs/user_guide/source/gui.rst
@@ -0,0 +1,2 @@
+Graphical User Interface (GUI)
+==============================
diff --git a/docs/user_guide/source/index.rst b/docs/user_guide/source/index.rst
new file mode 100644
index 0000000..4d916bb
--- /dev/null
+++ b/docs/user_guide/source/index.rst
@@ -0,0 +1,42 @@
+.. Agkyra documentation master file, created by
+   sphinx-quickstart on Tue Aug 25 12:52:58 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Agkyra User Guide
+=================
+
+Agkyra is a syncing client for Pithos_ Storage. It is a multi-platform,
+stand-alone, end-user application. It synchronizes the contents of local user
+directories with remote Pithos containers through a
+`Graphical User Interface (GUI)` as well as a `Command Line Interface (CLI)`.
+
+Agkyra is implemented and supported by the `Synnefo Development Team`_ of the
+`Greek Research and Technology Network`_ and is an open source project,
+licensed under GPL v3.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :glob:
+
+   setup
+   gui
+   cli
+   settings
+   troubleshooting
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. External links
+
+.. _Pithos: https://www.synnefo.org/docs/synnefo/latest/pithos.html
+.. _Synnefo Development Team: https://www.synnefo.org
+.. _Greek Research and Technology Network: http://www.grnet.gr
diff --git a/docs/user_guide/source/settings.rst b/docs/user_guide/source/settings.rst
new file mode 100644
index 0000000..679ffff
--- /dev/null
+++ b/docs/user_guide/source/settings.rst
@@ -0,0 +1,2 @@
+Settings
+========
\ No newline at end of file
diff --git a/docs/user_guide/source/setup.rst b/docs/user_guide/source/setup.rst
new file mode 100644
index 0000000..d02f86e
--- /dev/null
+++ b/docs/user_guide/source/setup.rst
@@ -0,0 +1,145 @@
+Installation
+============
+
+There are packages to easily install and run the application in all major
+platforms. There is also the option for downloading the source code and
+installing everything manually.
+
+Linux
+-----
+
+TODO
+
+Windows
+-------
+
+TODO
+
+Mac OS X
+--------
+
+TODO
+
+Install from source
+-------------------
+
+Essential Requirements:
+
+* `Python 2.7 <https://www.python.org/downloads/>`_
+* setuptools_
+
+GUI requirements:
+
+* nwjs_
+
+.. note:: If the nwjs_ installation is skipped, the GUI won't function, but the
+    CLI will
+
+When the essential requirements are installed, use setuptools to download and
+install the agkyra package. It contains a back-end, a UI helper, a CLI and a
+GUI.
+
+.. code-block:: console
+
+    $ pip install agkyra
+
+.. hint:: if `pip install` does not work in windows, try `easy_setup`
+
+To install the GUI, download the latest stable nwjs_ build and move it to the
+agkyra source directory.
+
+.. code-block:: console
+
+    $ wget http://dl.nwjs.io/v0.12.3/nwjs-v0.12.3-YOUR_OS-x32OR64.tar.gz
+    $ tar xvfz nwjs-v0.12.3-YOUR_OS-x32OR64.tar.gz
+    $ mv nwjs `$AGKYRA_SOURCE/agkyra/nwjs
+
+TODO: Different names between operating systems
+
+Setup
+=====
+
+Some essential settings must be provided in order for Agkyra to start syncing:
+
+* A synnefo cloud URL
+* A user authentication token
+* A remote container (if it does not exist, it will be created)
+* A local directory (if it does not exist, it will be created)
+
+.. note:: The full list of settings is detailed in the settings section
+
+If any of the above is missing or is outdated, agkyra will not be able to
+function properly. There are several ways to provide and update these settings
+
+GUI
+---
+
+Start agkyra (in GUI mode by default). If some of the required settings are
+missing, or the token fails to authenticate, the `Settings` window will pop up.
+Otherwise, click the tray icon and choose "Settings".
+
+In the `Settings` window:
+
+* The **cloud URL** must be provided manually.
+* To get the **user token**, click the "Login to retrieve token" to authenticate with a username and password. It has to be re-retrieved every time it expires or is invalidated in any other way.
+* Write the **container** name in the corresponding field. If the container does not exist, it will be created automatically, otherwise the contained data will be preserved and synchronized.
+* Select the **local directory** by clicking the `Select` button and using the pop up dialog.
+
+To apply the settings, press the `Save` button. If the Settings window is
+closed without saving, all changes will be lost.
+
+CLI
+---
+
+Use the **agkyra-cli config** commands to set and update settings:
+
+.. code-block:: console
+
+    --- Set up a cloud named CLD ---
+    $ agkyra-cli config set cloud CLD url http://www.example.org/identity/v2.0
+    $ agkyra-cli config set cloud CLD token ex4mpl3-t0k3n
+
+    --- Set up a sync (cloud, local directory, container) named SNC ---
+    $ agkyra-cli config set sync SNC directory /my/local/directory
+    $ agkyra-cli config set sync SNC cloud CLD
+    $ agkyra-cli config set sync SNC container remote_container
+
+    --- Set the SNC sync as the default ---
+    $ agkyra-cli config set default_sync CLD
+
+
+.. note:: use the **agkyra-cli config list** command for the current settings
+
+
+Config file
+-----------
+
+The config file is `HOME_DIRECTORY/.agkyra/config.rc` and can be edited,
+although this practice is discouraged. The config file format is modeled after
+the corresponding `kamaki.rc` format.
+
+Here is a typical configuration:
+
+.. code-block:: text
+
+    # Agkyra configuration file version 0.2
+    [global]
+    default_sync = CLD
+    language = en
+    sync_on_start = on
+
+    [cloud "CLD"]
+    url = http://www.example.org/identity/v2.0
+    token = ex4mpl3-t0k3n
+
+    [sync "SNC"]
+    directory = /my/local/directory
+    container = agkyra
+    cloud = CLD
+
+Users can create as many clouds and syncs as they like, but only the
+`default_sync` cloud is running each time `agkyra` is launched.
+
+.. _Python: http://www.python.org
+.. _setuptools: https://pypi.python.org/pypi/setuptools/
+.. _nwjs: http://nwjs.io/
diff --git a/docs/user_guide/source/troubleshooting.rst b/docs/user_guide/source/troubleshooting.rst
new file mode 100644
index 0000000..7817fcf
--- /dev/null
+++ b/docs/user_guide/source/troubleshooting.rst
@@ -0,0 +1,2 @@
+Troubleshooting
+===============
\ No newline at end of file
-- 
GitLab