1. sirgazil
  2. colorin

Commits

sirgazil  committed 7981ae5 Draft

Added independent docs sections

  • Participants
  • Parent commits 89121e7
  • Branches default

Comments (0)

Files changed (4)

File docs/source/index.rst

View file
 *colorin* is a Python package for coloring output in text terminals.
 
 
-Installing
-==========
-
-.. note::
-
-   If you're using `virtual environments <http://www.virtualenv.org/>`_,
-   omit ``sudo`` in the following instructions.
-
-To install ``colorin`` for the first time, run this command in a terminal:
-
-.. sourcecode:: console
-
-   $ sudo pip install colorin
-
-If you already have a previous version installed:
-
-.. sourcecode:: console
-
-   $ sudo pip install --upgrade colorin
-
-To uninstall ``colorin``, run this command:
-
-.. sourcecode:: console
-
-   $ sudo pip uninstall colorin
-
-
-Basic usage
-===========
-
-.. sourcecode:: python
-
-   #! /usr/bin/env python
-
-   from colorin.cli import Display
-
-
-   screen = Display()
-   screen.color("Hello world!", "Green")
-
-
 .. toctree::
    :maxdepth: 2
+   
+   license
+   install
 
 
 

File docs/source/install.rst

View file
+Installing
+==========
+
+.. note::
+
+   If you're using `virtual environments <http://www.virtualenv.org/>`_,
+   omit ``sudo`` in the following instructions.
+
+To install ``colorin`` for the first time, run this command in a terminal:
+
+.. sourcecode:: console
+
+   $ sudo pip install colorin
+
+
+Upgrading
+---------
+
+If you already have a previous version installed:
+
+.. sourcecode:: console
+
+   $ sudo pip install --upgrade colorin
+
+
+Uninstalling
+------------
+
+To uninstall ``colorin``, run this command:
+
+.. sourcecode:: console
+
+   $ sudo pip uninstall colorin

File docs/source/license.rst

View file
+License
+=======
+
+| Copyright (c) 2012 Felipe Lopez, *aka sirgazil*
+| felipe.lopac@gmail.com
+| http://sirgazil.info/
+
+| *colorin* is a free cultural work; you can redistribute it and/or modify it
+| under the terms of the Creative Commons 0 Public Domain Dedication
+| (CC0 1.0).
+
+| You should have received a copy of the Creative Commons 0 legal code
+| along with this work.  If not, see:
+| http://creativecommons.org/publicdomain/zero/1.0/.

File docs/source/usage.rst

View file
+Usage
+=====
+
+.. sourcecode:: python
+
+   #! /usr/bin/env python
+
+   from colorin.cli import Display
+
+
+   screen = Display()
+   screen.color("Hello world!", "Green")