summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..cc5deb41
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,29 @@
+Welcome to Glances's documentation!
+===================================
+
+**Glances** is a cross-platform curses-based monitoring tool written in Python.
+
+It uses the PSUtil library and some internal code to get information from your system.
+
+.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png
+
+
+Get the code
+------------
+
+The `source <http://github.com/nicolargo/glances>`_ is available on Github.
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+ glances-doc
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`