Skip to content

Commit

Permalink
Add a short README.
Browse files Browse the repository at this point in the history
  • Loading branch information
chromakode committed Feb 5, 2013
1 parent 44bfce4 commit b291f5e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<img src="https://secure.gravatar.com/avatar/c638493729c2f009988c9e5bd9b5e116?s=200" align="right">

# reddit

This is the primary codebase that powers [reddit.com](http://www.reddit.com).

For notices about major changes and general discussion of reddit development, subscribe to the [/r/redditdev](http://www.reddit.com/r/redditdev) subreddit.

You can also chat with us via IRC in [#reddit-dev on FreeNode](http://webchat.freenode.net/?channels=reddit-dev).

---

### Quickstart

To set up your own instance of reddit to develop with, we have a handy [install script for Ubuntu](https://github.com/reddit/reddit/wiki/reddit-install-script-for-Ubuntu) that will automatically install and configure most of the stack.

Alternatively, refer to our [Install Guide](https://github.com/reddit/reddit/wiki/Install-guide) for instructions on setting up reddit from scratch. Many frequently asked questions regarding local reddit installs are covered in our [FAQ](https://github.com/reddit/reddit/wiki/FAQ).

### APIs

To learn more about reddit's API, check out our [Automated API documentation](http://www.reddit.com/dev/api), and the [API wiki page](https://github.com/reddit/reddit/wiki/API). Please use a unique User-Agent string and take care to abide by our [API rules](https://github.com/reddit/reddit/wiki/API#wiki-rules).

Happy hacking!

0 comments on commit b291f5e

Please sign in to comment.