From f87a71f511dc5653c25964128666a8d808f86b35 Mon Sep 17 00:00:00 2001 From: Amjith Ramanujam Date: Fri, 19 Dec 2014 00:32:26 -0800 Subject: [PATCH] Update readme and develop docs. --- DEVELOP.rst | 4 ++-- README.rst | 14 +++++++++++++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/DEVELOP.rst b/DEVELOP.rst index 85280a37..07d8e767 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -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 . diff --git a/README.rst b/README.rst index 436849bf..1737f395 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ + Detailed Installation Instructions: ----------------------------------- @@ -126,7 +138,7 @@ Then you can install pgcli: Thanks: -======= +------- A special thanks to `Jonathan Slenders `_ for creating `Python Prompt Toolkit `_,