Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
C. E. Brasseur authored May 7, 2019
1 parent 8ef9a31 commit 66ec8de
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,40 @@ Developer Documentation

Installation
^^^^^^^^^^^^

.. code-block:: bash
$ git clone https://github.com/spacetelescope/astrocut.git
$ cd astrocut
$ python setup.py install
For active developement intall in develop mode

.. code-block:: bash
$ python setup.py develop
Testing
^^^^^^^
Tests can be found in ``astrocut/tests/``.

.. code-block:: bash
$ python setup.py test
Documentation
^^^^^^^^^^^^^

Documentation files are found in ``docs/``.

To build the documentation:

.. code-block:: bash
$ python setup.py build_docs
The built docs will be in ``docs/_build/html/``, to view them go to ``file:///path/to/astrocut/repo/docs/_build/html/index.html`` in the browser of your choice.


Release Protocol
^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 66ec8de

Please sign in to comment.