Changes on documentation homepage layout. Separate installation and c…

…ompilation instructions.

docs/compilation.rst

@@ -29,13 +29,13 @@ The following libraries must be installed on the system in order to compile Cane
   * Qt 5
   * Qwt 6.1.2 or later
 
-Although the package *Ngspice*  is optional, it is strongly recommended to install it to add simulation capabilities to Caneda.
+Although the package **Ngspice**  is optional, it is strongly recommended to install it in order to add simulation capabilities to Caneda.
 
 **Source Code**
 
 Caneda source code repository can be locally cloned using **git** as follows:
 
-.. code-block:: example
+.. code-block:: none
 
   $ git clone https://github.com/caneda/caneda
 
@@ -46,30 +46,30 @@ Alternatively, download either `master`_ or `develop`_ tarball from the GitHub r
 .. _`master`:  https://github.com/Caneda/Caneda/tarball/master
 .. _`develop`: https://github.com/Caneda/Caneda/tarball/develop
 
-.. code-block:: example
+.. code-block:: none
 
   $ tar -xvf Caneda-Caneda-<version>.tar.gz
 
 **Compilation Steps**
 
 Create a new folder ``build`` at the top of Caneda source code structure and change into it:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd caneda
   $ mkdir build
   $ cd build
   
 Configure and compile the source package:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cmake ../
   $ make
 
 Finally, install Caneda into the system (requires root privileges):
 
-.. code-block:: example
+.. code-block:: none
 
   # make install
   
@@ -81,7 +81,7 @@ Run ``cmake --help`` for details on some of the pertinent environment variables.
 CMake can take initial values for configuration parameters by setting environment variables from the command line. 
 Here is an example:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cmake CC=gcc-6 CXX=g++-6 CFLAGS=-O2 LIBS=-lposix ../
 
@@ -100,7 +100,7 @@ In addition, if you use a non-standard directory layout, you can give options li
 
 To associate Caneda file types with the application itself, execute the following command:
 
-.. code-block:: example
+.. code-block:: none
 
   $ update-mime-database /usr/local/share/mime
 
@@ -117,23 +117,23 @@ Consider the prefix ``$`` for non-privileged user commands and the prefix ``#``
 
 Use **aptitude** to install the required/suggested packages:
 
-.. code-block:: example
+.. code-block:: none
 
   # aptitude install git cmake g++ qtbase5-dev libqt5svg5-dev qttools5-dev qttools5-dev-tools ngspice libqwt-qt5-dev 
     
 .. note:: The simulation engine **Ngspice** is available at the *non-free* Debian repository. Before trying to install it, edit the file **/etc/apt/sources.list** as **root** and make sure the keyword *non-free* is present in the repository details. For example: ``deb http://ftp.us.debian.org/debian/ stretch main non-free``.
 
 Create a temporary folder and change to it:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd ~
   $ mkdir temp_caneda
   $ cd temp_caneda
       
 Get the latest Caneda *git* snapshot:
 
-.. code-block:: example
+.. code-block:: none
 
   $ git clone https://github.com/caneda/caneda
 
@@ -144,28 +144,28 @@ Alternatively, download either `master`_ or `develop`_ tarball from the GitHub r
 .. _`master`:  https://github.com/Caneda/Caneda/tarball/master
 .. _`develop`: https://github.com/Caneda/Caneda/tarball/develop
 
-.. code-block:: example
+.. code-block:: none
 
   $ tar -xvf Caneda-Caneda-<version>.tar.gz
     
 Create the folder ``build`` at the top of the source code structure and change into it:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd caneda
   $ mkdir build
   $ cd build
     
 Configure the source package and start the compilation process:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cmake ../
   $ make
     
 Install Caneda into the system by executing:
 
-.. code-block:: example
+.. code-block:: none
 
   # make install
       
@@ -183,15 +183,15 @@ Consider the prefix ``$`` for non-privileged user commands and the prefix ``#``
 
 Use **aptitude** to install the required/suggested packages:
 
-.. code-block:: example
+.. code-block:: none
 
   # aptitude install git cmake g++ qtbase5-dev libqt5svg5-dev qttools5-dev qttools5-dev-tools ngspice
 
 .. note:: The simulation engine **Ngspice** is available at the *non-free* Debian repository. Before trying to install it, edit the file **/etc/apt/sources.list** as **root** and make sure the keyword *non-free* is present in the repository details. For example: ``deb http://ftp.us.debian.org/debian/ jessie main non-free``.
 
 Create a temporary folder and change to it:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd ~
   $ mkdir temp_caneda
@@ -203,33 +203,33 @@ Download the latest `Qwt libraries`_  (e.g. release 6.1.2) and unpack it:
 
 .. _`Qwt libraries`: https://sourceforge.net/projects/qwt/files/latest/download
 
-.. code-block:: example
+.. code-block:: none
 
   $ tar -xvf qwt-6.1.2.tar.bz2
 
 Change to Qwt folder to configure and compile the source code:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd qwt-6.1.2
   $ /usr/lib/x86_64-linux-gnu/qt5/bin/qmake qwt.pro
   $ make
 
 Install Qwt into the system:
 
-.. code-block:: example
+.. code-block:: none
 
   # make install
   
 Go back to the temporary folder created earlier:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd ~/temp_caneda
 
 Get the latest Caneda *git* snapshot:
 
-.. code-block:: example
+.. code-block:: none
 
   $ git clone https://github.com/caneda/caneda
 
@@ -240,34 +240,34 @@ Alternatively, download either `master`_ or `develop`_ tarball from the GitHub r
 .. _`master`:  https://github.com/Caneda/Caneda/tarball/master
 .. _`develop`: https://github.com/Caneda/Caneda/tarball/develop
 
-.. code-block:: example
+.. code-block:: none
 
   $ tar -xvf Caneda-Caneda-<version>.tar.gz
     
 Create the folder ``build`` at the top of the source code structure and change into it:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cd caneda
   $ mkdir build
   $ cd build
     
 Configure the source package and start the compilation process:
 
-.. code-block:: example
+.. code-block:: none
 
   $ cmake ../
   $ make
     
 Install Caneda into the system by executing:
 
-.. code-block:: example
+.. code-block:: none
 
   # make install
       
 To open Caneda, point explicitly to Qwt 6.1.2 library path as follows:
 
-.. code-block:: example
+.. code-block:: none
 
   $ LD_LIBRARY_PATH=/usr/local/qwt-6.1.2/lib/ caneda &
 

docs/gettingstarted.rst

@@ -1,13 +1,16 @@
+###############
 Getting Started
-===============
+###############
+
 This is a brief introduction to Caneda's functionalities to get you ready on track. There are basically two ways to get started using Caneda right from scratch:
 
 * Using the schematic context and creating a new design
 * Using one of the circuit examples available from the *Example Circuits* repository.
 
-
+**********************
 Interface Introduction
-----------------------
+**********************
+
 In the following image the Caneda main window is shown, along with the initial tools and default configuration. The user interface is fully configurable, and you can show, hide or move any tool to your personal preferences.
 
 .. image:: /images/mainwindow.png
@@ -35,9 +38,10 @@ Finally, the folder browser allows you to easily access your files from a conven
 
 .. image:: /images/folderBrowser.png
 
-
+*******************
 Create a New Design
--------------------
+*******************
+
 In the following example, we will introduce the basic usage by creating a simple opamp based amplifier. To start a new design, click on the *New* icon from the file toolbar.
 
 .. image:: /images/document-new.png
@@ -69,9 +73,10 @@ To get a meaningful result, you should also add a source.
 
 Once you are done, you are ready to perform your first simulation in Caneda.
 
-
+**********************
 Performing Simulations
-----------------------
+**********************
+
 To start a new simulation, click on the simulate tool in the main toolbar.
 
 .. image:: /images/simulate.png
@@ -84,16 +89,18 @@ To select the displayed waveforms, click on the *Visible* option from the simula
 
 .. image:: /images/selectingWaveforms.png
 
-
+***********
 Text editor
------------
+***********
+
 Caneda has an embedded text editor, which allows you to create and design all kinds of text code based simulations. The most common forms are spice and hdl (verilog and vhdl) simulations. To help you realize your design, a ready to use set of templates is available from the text sidebar. Once you have your design ready, just click on the simulate tool as in the above example and Caneda will perform the simulation for you, using the appropiate tools.
 
 .. image:: /images/texteditor.png
 
-
+****************
 Circuit Examples
-----------------
+****************
+
 There is a repository hosted at `Example Circuits <https://github.com/Caneda/Examples>`_ which contains example circuits for Caneda, ready to use. The example circuits are continuously updated and improved, and periodically new circuits are added.
 
 To try any circuit, simply download the selected schematic to your machine and open it using Caneda. All circuits are ready for simulation using Caneda's tools. Inside each schematic there are specific details to the circuit, where applicable.

docs/index.rst

@@ -1,27 +1,38 @@
-Welcome to Caneda's documentation!
-==================================
-Caneda is an open source EDA software suite focused on ease of use and portability. Its main goal is to handle the complete design process: schematic capture, simulation and circuit layout or PCB. Caneda aims to support all kinds of circuit simulation types, e.g. DC, AC, S-parameter and harmonic balance analysis.
+###########################
+Caneda Documentation Center
+###########################
+
+Caneda is an open source EDA software suite focused on ease of use and portability. 
+Its main goal is to handle the complete design process: schematic capture, simulation and circuit layout or PCB. 
+Caneda aims to support all kinds of circuit simulation types, e.g. DC, AC, S-parameter and harmonic balance analysis.
 
 .. image:: /images/caneda.png
 
-For details visit the project's homepage:
+For details visit the `Project Homepage`_.
 
-http://www.caneda.org
+.. _`Project Homepage`: http://caneda.org
 
-Contents:
+*****************
+Table of Contents
+*****************
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 5
 
-   install
+   installation
    gettingstarted
    libraries
+   compilation
 
+**********
 Contribute
-==========
+**********
+
 - Issue Tracker: http://github.com/Caneda/Caneda/issues
 - Source Code: http://github.com/Caneda/Caneda
 
+*******
 License
-=======
-The project is licensed under the GPLv2 license.
+*******
+
+This project is licensed under GPLv2.

docs/installation.rst

@@ -6,8 +6,7 @@ Installation
 GNU/Linux
 *********
 
-The installation procedure of Caneda in GNU/Linux may differ between distributions.
-Execute ``lsb_release -da`` from a system console to check the Linux distribution name and release. Then select the installation instructions accordingly.
+.. note:: To obtain the distribution name and release of a particular system, execute ``lsb_release -da`` from a system console.
 
 Debian 9 Stretch/Testing
 ========================
@@ -21,25 +20,34 @@ Consider the prefix ``$`` for non-privileged user commands and the prefix ``#``
 
 Make sure the system package list is updated by executing:
 
-.. code-block:: example
+.. code-block:: none
 
   # aptitude update
 
-Install packages ``caneda`` (main) and ``ngspice`` (simulation engine) by simply executing:
+Install **Caneda** (main) and **Ngspice** (simulation engine) by simply executing:
 
-.. code-block:: example
+.. code-block:: none
 
   # aptitude install caneda ngspice
 
-.. note:: The simulation engine **Ngspice** is a *non-free* package. Before trying to install it, edit the file **/etc/apt/sources.list** as ``root`` and make sure the keyword ``non-free`` is present in the repository details. For example: ``deb http://ftp.us.debian.org/debian/ stretch main non-free``.
+.. note:: The simulation engine **Ngspice** is available at the *non-free* Debian repository. Before trying to install it, edit the file **/etc/apt/sources.list** as **root** and make sure the keyword *non-free* is present in the repository details. For example: ``deb http://ftp.us.debian.org/debian/ stretch main non-free``.
 
-To open Caneda from KDE Application Launcher, go to **Applications** > **Development** and then click on *Caneda*. 
+To open Caneda from the Application Launcher, go to **Applications** > **Development** and then click on *Caneda*. 
 
-Alternatively, open Caneda from a terminal emulator (e.g. Konsole) by executing ``caneda &``.
+Alternatively, open Caneda from a terminal emulator by executing ``caneda &``.
 
 Debian 8 Jessie/Stable
 ======================
 
 Although Caneda is not currently available at the Debian repository for Jessie/Stable, it can be installed from its source code. 
-Please read **Compilation for Debian 8 Jessie/Stable** for detailed instructions.
+Please read :doc:`compilation` for step-by-step instructions.
 
+*****************
+Microsoft Windows
+*****************
+
+Caneda *stable* release is currently supported in Microsoft Windows systems. 
+
+Simply download the Caneda installation executable `CanedaInstaller_<latest>.exe`_ and double-click it to begin the installation process. 
+
+.. _`CanedaInstaller_<latest>.exe`: https://github.com/Caneda/Caneda/releases/download/0.2.0/CanedaInstaller_0.2.0.exe