Skip to content

Commit

Permalink
Merge pull request #3102 from WorldBrain/install-docs-write-up
Browse files Browse the repository at this point in the history
Install docs fixups
  • Loading branch information
nickstenning committed Mar 17, 2016
2 parents 3ad27db + 391a68c commit 683002c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 38 deletions.
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Miscellanea
===================

Bug fixes
--------
---------

- Replies are now correctly displayed after creation (#3057).

Expand Down
58 changes: 21 additions & 37 deletions docs/hacking/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ h. If you are looking for instructions on deploying h in a production
environment, please consult the :doc:`/INSTALL` instead.


Get the h source code from GitHub
---------------------------------

Use ``git`` to download the h source code:

.. code-block:: bash
git clone https://github.com/hypothesis/h.git
This will download the code into an ``h`` directory in your current working
directory.


Requirements
------------

Expand Down Expand Up @@ -177,50 +190,21 @@ system that Docker can be installed on:
.. _Docker website: https://www.docker.com/


Get the h source code from GitHub
---------------------------------

Use ``git`` to download the h source code:

.. code-block:: bash
git clone https://github.com/hypothesis/h.git
This will download the code into an ``h`` directory in your current working
directory.


Install h into a Python virtualenv
----------------------------------

Although it is strictly optional, we highly recommend that you install h inside
a Python "virtualenv". First, follow the instructions for your platform on
installing virtualenvwrapper_. Then, at a shell, you can create a virtualenv for
the h application with:

.. code-block:: bash
mkvirtualenv h
You will notice that the your shell prompt changes to include a (h) symbol. That
means that you now have your virtual environment activated. This is required for
running the code.

At any later time, you can activate your virtualenv by running:

.. code-block:: bash
workon h
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/install.html

Running h
---------

Run the following command to start the Hypothesis web service. If this is a
fresh clone of the repository, this may take some time to run, as it will need
to install the application dependencies and build the client assets.

.. note::
Although it is strictly optional, we highly recommend that you install h
inside a Python "virtualenv". Please refer to the `virtualenv environment`_
section featured in the Hitchhiker's guide to Python for a comprehensive
introduction.

.. _virtualenv environment: http://docs.python-guide.org/en/latest/dev/virtualenvs/

.. code-block:: bash
make dev
Expand Down

0 comments on commit 683002c

Please sign in to comment.