Skip to content

Commit

Permalink
Added "$" before command lines
Browse files Browse the repository at this point in the history
  • Loading branch information
muriloviana committed Oct 9, 2017
1 parent dea22a6 commit 7aed91d
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions CONTRIBUTING.rst
Expand Up @@ -6,43 +6,41 @@ so do not hesitate!

Contributions can be made in the form of feature requests, bug reports and feedback.


First Time
----------

- Download and install the `latest version of git`_.
- Configure git with your `username`_ and `email`_::

git config --global user.name 'your name'
git config --global user.email 'your email'
$ git config --global user.name 'your name'
$ git config --global user.email 'your email'

- Make sure you have a `GitHub account`_.
- Fork Bottery to your GitHub account by clicking the `Fork`_ button.
- `Clone`_ your GitHub fork locally::

git clone https://github.com/{username}/bottery/
cd bottery
$ git clone https://github.com/{username}/bottery/
$ cd bottery

- Add the main repository as a remote to update later::

git remote add rougeth https://github.com/rougeth/bottery
git fetch rougeth

- Create a virtualenv::

python3 -m venv env
. env/bin/activate
# or "env\Scripts\activate" on Windows
$ git remote add rougeth https://github.com/rougeth/bottery
$ git fetch rougeth

- Create a `virtualenv`_.
- Install Bottery in editable mode with development dependencies::

pip install -e ".[dev]"
$ pip install -e ".[dev]"

.. _GitHub account: https://github.com/join
.. _latest version of git: https://git-scm.com/downloads
.. _username: https://help.github.com/articles/setting-your-username-in-git/
.. _email: https://help.github.com/articles/setting-your-email-in-git/
.. _Fork: https://github.com/rougeth/bottery#fork-destination-box
.. _Clone: https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork
.. _virtualenv: http://docs.bottery.io/en/latest/installation.html#virtualenv


Development
-----------
Expand Down

0 comments on commit 7aed91d

Please sign in to comment.