1
0
Fork 0

Update readme and develop docs.

This commit is contained in:
Amjith Ramanujam 2014-12-19 00:32:26 -08:00
parent 8bd1d9dd7e
commit f87a71f511
2 changed files with 15 additions and 3 deletions

View File

@ -18,7 +18,7 @@ In order to keep your fork up to date with any changes from mainline, add a new
git remote to your local copy called 'upstream' and point it to the main pgcli
repo.
.. ::
::
$ git remote add upstream git@github.com:amjith/pgcli.git
@ -42,7 +42,7 @@ Create a virtualenv (let's call it pgcli-dev). Once the virtualenv is activated
`cd` into the local clone of pgcli folder and install pgcli using pip as
follows:
.. ::
::
$ pip install --editable .

View File

@ -58,6 +58,18 @@ The `pgcli` is written using prompt_toolkit_.
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit
Contributions:
--------------
If you're interested in contributing to this project, first of all I would like
to extend my heartfelt gratitude. I've written a small doc to describe how to
get this running in a development setup.
https://github.com/amjith/pgcli/blob/master/DEVELOP.rst
Please feel free to reach out to me if you need help.
My email: amjith.r@gmail.com, Twitter: `@amjithr <http://twitter.com/amjithr>`_
Detailed Installation Instructions:
-----------------------------------
@ -126,7 +138,7 @@ Then you can install pgcli:
Thanks:
=======
-------
A special thanks to `Jonathan Slenders <https://twitter.com/jonathan_s>`_ for
creating `Python Prompt Toolkit <http://github.com/jonathanslenders/python-prompt-toolkit>`_,