Link: Add is_archived() to skip subreddit lookup when possible
[reddit.git] / README.md
blob5d33001cd198d997ffe04e408c3df0b581dc459d
1 # reddit
3 <img src="https://secure.gravatar.com/avatar/c638493729c2f009988c9e5bd9b5e116?s=200" align="right">
5 Greetings!
7 This is the primary codebase that powers [reddit.com](http://www.reddit.com).
9 For notices about major changes and general discussion of reddit development, subscribe to the [/r/redditdev](http://www.reddit.com/r/redditdev) and [/r/changelog](http://www.reddit.com/r/changelog) subreddits. 
11 You can also chat with us via IRC in [#reddit-dev on freenode](http://webchat.freenode.net/?channels=reddit-dev).
13 ---
15 ### Quickstart
17 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.
19 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).
21 ### APIs
23 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).
25 Happy hacking!
27 ### Issues and Contribution Guidelines
29 Thanks for wanting to help make reddit better! First things first, though: **github issues is only for _confirmed_, active bugs**. Please submit ideas to [/r/ideasfortheadmins](https://www.reddit.com/r/ideasfortheadmins/).
31 Please read more on contributions in [CONTRIBUTING.md](CONTRIBUTING.md).