aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorTrygve Laugstøl <trygvis@inamo.no>2018-08-05 22:52:03 +0200
committerTrygve Laugstøl <trygvis@inamo.no>2018-08-05 22:52:03 +0200
commite0ec25e03d0584054b40ae63c27dbe4b06caa7bd (patch)
tree3c7f6463c673d744d2c638577e4e4a74bab805a0 /docs/index.rst
parent497d26a2755289f1633e6e3d8291a13254e4a5b7 (diff)
downloadee-python-e0ec25e03d0584054b40ae63c27dbe4b06caa7bd.tar.gz
ee-python-e0ec25e03d0584054b40ae63c27dbe4b06caa7bd.tar.bz2
ee-python-e0ec25e03d0584054b40ae63c27dbe4b06caa7bd.tar.xz
ee-python-e0ec25e03d0584054b40ae63c27dbe4b06caa7bd.zip
o More docs for the ee project.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst33
1 files changed, 20 insertions, 13 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 7c8a81e..212eb9d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,21 +1,28 @@
-.. EE Tools documentation master file, created by
- sphinx-quickstart on Mon Jul 30 21:29:33 2018.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+EE Tools
+========
+
+The ``ee`` project's main goals is to make it to automate and increase the quality of electronics engineering projects.
+
+The implementation 1) a bunch of Python code to work with EE-related programs and file formats and 2) a bunch of
+`DoIt <http://pydoit.org>`_ tasks.
+
+Currently the project support these tools:
+
+* `KiCAD <http://kicad.org>`_
+* `LTSpice <http://www.analog.com/en/design-center/design-tools-and-calculators/ltspice-simulator.html>`_
-Welcome to EE Tools's documentation!
-====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
-Hello world!
-
+ getting-started
+ background
-Indices and tables
-==================
+..
+ Indices and tables
+ ==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+ * :ref:`genindex`
+ * :ref:`modindex`
+ * :ref:`search`