Skip to content

Commit

Permalink
Merge pull request #2 from mattrose/update-readme
Browse files Browse the repository at this point in the history
add build instructions to README
  • Loading branch information
mattrose committed Jan 7, 2021
2 parents 9ffb8c5 + e77fd1f commit 2bd3445
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ The main Terminator icon was created by Cory Kontros, and provided under the `CC

This Manual and included images are wholly new pieces created by the current maintainer Steve Boddy, and are distributed under the `CC-BY-SA`_ licence, as are the horrific attempts by yours truly at using Cory’s icon to provide page identities.

How to Build
------------

* Install the shinx package and the ReadTheDocs theme `pip install sphinx sphinx-rtd-theme`
* Clone this repository
* ``cd docs``
* Build the HTML pages ``make html``
* serve up the web pages: ``cd _build/html && python -m SimpleHTTPServer 4000``
* Review the results at http://localhost:4000

Imported from Launchpad: https://code.launchpad.net/~gnome-terminator/terminator/manual-gtk3

.. _CC-BY-SA: http://creativecommons.org/licenses/by-sa/4.0/

0 comments on commit 2bd3445

Please sign in to comment.