Skip to content

Commit

Permalink
Added a 'Installation' section to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kemelzaidan committed May 1, 2014
1 parent 6def56e commit 928a708
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,41 @@ The name `Pingo`_ is a tribute to `Garoa Hacker Clube`_, where the project start
.. _Pingo: https://garoa.net.br/wiki/Pingo
.. _Garoa Hacker Clube: https://garoa.net.br/wiki/Garoa_Hacker_Clube:About

------------
Installation
------------

Basicly, there are two ways of installing Pingo:

1. from Python Pip
2. from Github (recommended)

Installing Pingo from Pip installer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To install Pingo from Pip installer, first, make sure you have pip installed in your machine. On Linux machines, this usually means you have the `python-pip` package installed. You can check if you have pip in your machine by typing the following text on a shell prompt:

>>> $ pip --version
pip 1.5.4 from /usr/lib/python2.7/dist-packages (python 2.7)
>>>

If the output is similar from the one above, you can install Pingo by simple typing `pip install pingo` as root on you terminal. That's it!

Installing Pingo from Github
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Since Pingo is actually in alpha state and under heavy develpment right now, installing Pingo from Github can be a good idea. Besides that, it will be easy for you to collaborate with the project, if you wish. See the Contributing section on the left menu.

To install Pingo from Github, you must have Git installed. Presuming you already have that, just type:

`git clone https://github.com/garoa/pingo.git`

After that, get into the pingo directory and setup Python to use your brand new directory as a library:

`python setup.py install`

Done! You are ready to program using Pingo!

-----------
Basic usage
-----------
Expand Down

0 comments on commit 928a708

Please sign in to comment.