Skip to content

Commit

Permalink
DOC: Add TOC to help page, improve wording.
Browse files Browse the repository at this point in the history
  • Loading branch information
ggventurini committed Mar 28, 2015
1 parent 5d93e78 commit 61054b2
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions deltasigma/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
# LICENSE file for the licensing terms.

"""
*A port of the* **MATLAB Delta Sigma Toolbox** *based on free software and
very little sleep.*
:Author: Giuseppe Venturini, based on Richard Schreier's work, who deserves most of the credit.
:Release: |release|
Expand All @@ -27,12 +29,10 @@
**Bug tracker:** https://github.com/ggventurini/python-deltasigma/issues
Introduction
------------
A port of the **MATLAB Delta Sigma Toolbox** based on free software and
very little sleep.
**Python-deltasigma** is a Python package to *synthesize, simulate,
scale and map to implementable structures* **delta sigma modulators**.
Expand All @@ -42,6 +42,11 @@
the *de facto* standard tool for high-level delta sigma simulation, upon
which it is very heavily based.\ |githalytics.com alpha|
Contents
--------
.. contents:: Contents
Status
------
Expand Down Expand Up @@ -106,8 +111,8 @@
- *Archs*: x86, x86\_64 and armf (arm with floating point unit).
Dependencies
~~~~~~~~~~~~
Required dependencies
~~~~~~~~~~~~~~~~~~~~~
Using ``python-deltasigma`` requires `Python 2 or 3 <http://www.python.org/>`__,
at your choice, `numpy <http://www.numpy.org/>`__,
Expand Down Expand Up @@ -150,8 +155,8 @@
yourself <https://github.com/ahkab/ahkab/wiki/Install:-numpy-and-scipy>`__,
which also apply here. Be warned, it can easily get complicated.
Optional dependencies
~~~~~~~~~~~~~~~~~~~~~
Optional (but recommended) dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The required dependencies have been kept to a minimum to allow running
``python-deltasigma`` on workstations that are not managed by the user
Expand Down Expand Up @@ -184,8 +189,8 @@
The Cython extensions were written by Sergio Callegari, please see the
``deltasigma/`` for copyright notice and more information.
Install python-deltasigma
~~~~~~~~~~~~~~~~~~~~~~~~~
Install the deltasigma package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once the dependencies set up, it is possible to install the latest stable
version directly from the `Python Package Index (PYPI)
Expand Down

0 comments on commit 61054b2

Please sign in to comment.