hy/README.md

Hy
==

[![Build Status](https://img.shields.io/travis/hylang/hy/master.svg)](https://travis-ci.org/hylang/hy)
[![Downloads](https://img.shields.io/pypi/dm/hy.svg)](https://pypi.python.org/pypi/hy)
[![Version](https://img.shields.io/pypi/v/hy.svg)](https://pypi.python.org/pypi/hy)
[![Coverage Status](https://img.shields.io/coveralls/hylang/hy/master.svg)](https://coveralls.io/r/hylang/hy)

<a href="https://xkcd.com/224/"><img title="We lost the documentation on quantum mechanics. You'll have to decode the regexes yourself." alt="XKCD #224" src="https://raw.github.com/hylang/shyte/18f6925e08684b0e1f52b2cc2c803989cd62cd91/imgs/xkcd.png"></a>

Lisp and Python should love each other. Let's make it happen. [Try it](http://try-hy.appspot.com/).

Hylarious Hacks
---------------

* [Django + Lisp](https://github.com/paultag/djlisp/tree/master/djlisp)
* [Python `sh` Fun](https://twitter.com/paultag/status/314925996442796032)
* [Hy IRC Bot](https://github.com/hylang/hygdrop)
* [miniKanren in Hy](https://github.com/algernon/adderall)

OK, so, why?
------------

Well. Python is awesome. So awesome, that we have so many tools to alter the
language in a *core* way, but we never use them.

Why?

Well, I wrote Hy to help people realize one thing about Python:

It's really awesome.

Oh, and lisps are neat.

![Cuddles the Hacker](https://i.imgur.com/QbPMXTN.png)

(fan art from the one and only [doctormo](http://doctormo.deviantart.com/art/Cuddles-the-Hacker-372184766))

Project
-------

* Code: https://github.com/hylang/hy
* Documentation:
  * stable, for use with the latest stable release: http://hylang.org/
  * master, for use with the latest revision on GitHub: http://docs.hylang.org/en/master
* Quickstart: http://hylang.org/en/stable/quickstart.html
* Bug reports: We have no bugs! Your bugs are your own! (https://github.com/hylang/hy/issues)
* License: MIT (Expat)
* [Hacking on Hy](http://docs.hylang.org/en/master/hacking.html)
  * [Contributor Guidelines](http://docs.hylang.org/en/master/hacking.html#contributor-guidelines)
  * [Code of Conduct](http://docs.hylang.org/en/master/hacking.html#contributor-code-of-conduct)
* IRC: Join #hy on [freenode](https://webchat.freenode.net/)
Adding in CI image 2013-03-06 19:28:23 -05:00			`Hy`
			`==`

Miscellaneous changes to README - Updated badges to utilize Shields - Added alt-text to images - Changed version/downloads badges to link to PyPI - Use Markdown list to enumerate Hylarious Hacks 2014-12-07 22:45:27 -08:00			`[![Build Status](https://img.shields.io/travis/hylang/hy/master.svg)](https://travis-ci.org/hylang/hy)`
			`[![Downloads](https://img.shields.io/pypi/dm/hy.svg)](https://pypi.python.org/pypi/hy)`
			`[![Version](https://img.shields.io/pypi/v/hy.svg)](https://pypi.python.org/pypi/hy)`
			`[![Coverage Status](https://img.shields.io/coveralls/hylang/hy/master.svg)](https://coveralls.io/r/hylang/hy)`
Add quickstart and hacking docs 2013-04-05 16:30:12 -04:00
Include original XKCD title text in comic image When I see an XKCD comic, or an adaptation thereof, my first instinct is to look for title text. Not finding any, this proposes adding the original title text back in; if a good Hy-specific adaptation is proposed that'd be even better. And no, this isn't important :) 2016-05-09 13:58:43 -04:00			`<a href="https://xkcd.com/224/"><img title="We lost the documentation on quantum mechanics. You'll have to decode the regexes yourself." alt="XKCD #224" src="https://raw.github.com/hylang/shyte/18f6925e08684b0e1f52b2cc2c803989cd62cd91/imgs/xkcd.png"></a>`
Move all badges to top of README. 2014-01-30 05:50:15 +02:00
			`Lisp and Python should love each other. Let's make it happen. [Try it](http://try-hy.appspot.com/).`

Adding in blurb 2013-03-20 19:41:19 -04:00			`Hylarious Hacks`
			`---------------`

Miscellaneous changes to README - Updated badges to utilize Shields - Added alt-text to images - Changed version/downloads badges to link to PyPI - Use Markdown list to enumerate Hylarious Hacks 2014-12-07 22:45:27 -08:00			`* [Django + Lisp](https://github.com/paultag/djlisp/tree/master/djlisp)`
			* [Python `sh` Fun](https://twitter.com/paultag/status/314925996442796032)
			`* [Hy IRC Bot](https://github.com/hylang/hygdrop)`
			`* [miniKanren in Hy](https://github.com/algernon/adderall)`
Adding in blurb 2013-03-20 19:41:19 -04:00
README update 2013-03-17 17:52:31 -04:00			`OK, so, why?`
			`------------`

			`Well. Python is awesome. So awesome, that we have so many tools to alter the`
the mega typo fix commit Wow! much typos! such fix! 2014-05-05 23:47:14 +05:30			`language in a core way, but we never use them.`
README update 2013-03-17 17:52:31 -04:00
			`Why?`

speling 2013-03-25 19:32:19 -04:00			`Well, I wrote Hy to help people realize one thing about Python:`
README update 2013-03-17 17:52:31 -04:00
Making readme more friendly 2014-02-10 17:29:35 -06:00			`It's really awesome.`
README update 2013-03-17 17:52:31 -04:00
			`Oh, and lisps are neat.`
Add quickstart and hacking docs 2013-04-05 16:30:12 -04:00
README: use HTTPS for the Imgur URL 2016-01-01 12:20:19 +01:00			`![Cuddles the Hacker](https://i.imgur.com/QbPMXTN.png)`
adding in @doctormo love 2013-05-17 20:52:52 -04:00
forgot this guy 2013-05-18 13:07:11 -04:00			`(fan art from the one and only [doctormo](http://doctormo.deviantart.com/art/Cuddles-the-Hacker-372184766))`
Add quickstart and hacking docs 2013-04-05 16:30:12 -04:00
			`Project`
			`-------`

update eww-arrr-el 2013-04-12 23:11:53 -04:00			`* Code: https://github.com/hylang/hy`
Update documentation links Fixes #1299. 2017-05-24 09:46:11 -07:00			`* Documentation:`
			`* stable, for use with the latest stable release: http://hylang.org/`
			`* master, for use with the latest revision on GitHub: http://docs.hylang.org/en/master`
			`* Quickstart: http://hylang.org/en/stable/quickstart.html`
update eww-arrr-el 2013-04-12 23:11:53 -04:00			`* Bug reports: We have no bugs! Your bugs are your own! (https://github.com/hylang/hy/issues)`
Add quickstart and hacking docs 2013-04-05 16:30:12 -04:00			`* License: MIT (Expat)`
Link to "Hacking on Hy" in the README 2017-08-05 12:04:16 -07:00			`* [Hacking on Hy](http://docs.hylang.org/en/master/hacking.html)`
			`* [Contributor Guidelines](http://docs.hylang.org/en/master/hacking.html#contributor-guidelines)`
			`* [Code of Conduct](http://docs.hylang.org/en/master/hacking.html#contributor-code-of-conduct)`
add IRC info in readme 2016-03-31 16:03:00 -04:00			`* IRC: Join #hy on [freenode](https://webchat.freenode.net/)`