hy/docs/quickstart.rst

==========
Quickstart
==========

.. image:: _static/cuddles-transparent-small.png
   :alt: Karen Rustard's Cuddles

(Thanks to Karen Rustad for Cuddles!)


**HOW TO GET HY REAL FAST**:

1. Create a `Virtual Python Environment
   <https://pypi.python.org/pypi/virtualenv>`_.
2. Activate your Virtual Python Environment.
3. Install `hy from GitHub <https://github.com/hylang/hy>`_ with ``$ pip install git+https://github.com/hylang/hy.git``.
4. Start a REPL with ``hy``.
5. Type stuff in the REPL::

       => (print "Hy!")
       Hy!
       => (defn salutationsnm [name] (print (+ "Hy " name "!")))
       => (salutationsnm "YourName")
       Hy YourName!

       etc

6. Hit CTRL-D when you're done.

*OMG! That's amazing! I want to write a Hy program.*

7. Open up an elite programming editor and type::

       #! /usr/bin/env hy
       (print "I was going to code in Python syntax, but then I got Hy.")

8. Save as ``awesome.hy``.
9. Make it executable::

        chmod +x awesome.hy

10. And run your first Hy program::

        ./awesome.hy

11. Take a deep breath so as to not hyperventilate.
12. Smile villainously and sneak off to your hydeaway and do
    unspeakable things.
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00			`==========`
			`Quickstart`
			`==========`

Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			`.. image:: _static/cuddles-transparent-small.png`
Adding in @aldeka 's cuddles image! 2013-06-02 04:02:52 +02:00			`:alt: Karen Rustard's Cuddles`

Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			`(Thanks to Karen Rustad for Cuddles!)`
Adding in @aldeka 's cuddles image! 2013-06-02 04:02:52 +02:00

Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			`HOW TO GET HY REAL FAST:`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			1. Create a `Virtual Python Environment
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			<https://pypi.python.org/pypi/virtualenv>`_.
			`2. Activate your Virtual Python Environment.`
change quickstart install from PyPI to GitHub (#1116) * change Quickstart install from PyPI to GitHub 2016-09-24 23:54:32 +02:00			3. Install `hy from GitHub <https://github.com/hylang/hy>`_ with ``$ pip install git+https://github.com/hylang/hy.git``.
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			4. Start a REPL with ``hy``.
Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			`5. Type stuff in the REPL::`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
			`=> (print "Hy!")`
			`Hy!`
example was missing function parameter name 2013-04-08 23:01:12 +02:00			`=> (defn salutationsnm [name] (print (+ "Hy " name "!")))`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00			`=> (salutationsnm "YourName")`
			`Hy YourName!`

			`etc`

Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			`6. Hit CTRL-D when you're done.`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
Adhere to CPython's documentation guidelines - Inline code is written using ``double backticks`` - Italicized text uses asterisks rather than `single backticks` - Function parameters are italicized rather than written as inline code 2014-12-07 07:05:52 +01:00			`OMG! That's amazing! I want to write a Hy program.`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
Visual and text changes in quickstart page. Kind of beautifying. It also includes transparent versions of Cuddles. 2014-01-16 10:01:32 +01:00			`7. Open up an elite programming editor and type::`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
docs: Add some documentation about #! Add the #! syntax to the quickstart guide, and to the tutorial as well. Fixes #992. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 2015-12-09 11:48:44 +01:00			`#! /usr/bin/env hy`
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			`(print "I was going to code in Python syntax, but then I got Hy.")`
Add quickstart and hacking docs 2013-04-05 22:30:12 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			8. Save as ``awesome.hy``.
docs: Add some documentation about #! Add the #! syntax to the quickstart guide, and to the tutorial as well. Fixes #992. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 2015-12-09 11:48:44 +01:00			`9. Make it executable::`
Tweak runline for easier reading 2013-04-06 03:27:30 +02:00
docs: Add some documentation about #! Add the #! syntax to the quickstart guide, and to the tutorial as well. Fixes #992. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 2015-12-09 11:48:44 +01:00			`chmod +x awesome.hy`
Add necessary conclusion to quickstart 2013-04-06 03:38:18 +02:00
docs: Add some documentation about #! Add the #! syntax to the quickstart guide, and to the tutorial as well. Fixes #992. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 2015-12-09 11:48:44 +01:00			`10. And run your first Hy program::`

			`./awesome.hy`

			`11. Take a deep breath so as to not hyperventilate.`
			`12. Smile villainously and sneak off to your hydeaway and do`
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes. 2014-12-06 08:13:40 +01:00			`unspeakable things.`