Yaltik/hy
2
0
Fork 0
Code Pull Requests Releases Activity

Update hacking guide.

Browse Source
This commit is contained in:
Berker Peksag 2013-10-08 05:16:31 +03:00
parent a038d3c592
commit 0248e42633
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/hacking.rst
View File

@ -2,6 +2,8 @@
Hacking on hy Hacking on hy
=============== ===============
.. highlight:: bash
Join our hyve! Join our hyve!
============== ==============
@ -21,24 +23,32 @@ Hack!
Do this: Do this:
1. create a `Python virtual environment 1. create a `virtual environment
<https://pypi.python.org/pypi/virtualenv>`_ <https://pypi.python.org/pypi/virtualenv>`_::
2. (optional) go to https://github.com/paultag/hy and fork it
3. get the source code::
$ git clone git://github.com/paultag/hy.git $ virtualenv venv
(or use your fork) and activate it::
4. install for hacking::
$ python setup.py develop $ . venv/bin/activate
2. get the source code::
5. install other develop-y requirements:: $ git clone https://github.com/hylang/hy.git
or use your fork::
$ git clone git@github.com:<YOUR_USERNAME>/hy.git
3. install for hacking::
$ cd hy/
$ pip install -e .
4. install other develop-y requirements::
$ pip install -r requirements-dev.txt $ pip install -r requirements-dev.txt
6. do awesome things; make someone shriek in delight/disgust at what 5. do awesome things; make someone shriek in delight/disgust at what
you have wrought you have wrought.
Test! Test!
@ -60,7 +70,7 @@ Document!
Documentation is located in ``docs/``. We use `Sphinx Documentation is located in ``docs/``. We use `Sphinx
<http://sphinx-doc.org/>`_. <http://sphinx-doc.org/>`_.
To build the docs in html:: To build the docs in HTML::
$ cd docs $ cd docs
$ make html $ make html