README.markdown
cc8985df
 # What is Octopress?
 Octopress gives developers a well designed starting point for a Jekyll blog. It's easy to configure and easy to deploy. Sweet huh?
58d342b5
 
1b484123
 #### Octopress comes with
e3a6bb7c
 1. A nice, easy to configure theme that focuses on readability.
fe3590be
 2. Built in support for Twitter, Delicious, Disqus Comments, Google Analytics, and Custom Search.
 3. Rake tasks that make development fast, and deploying easy.
1b484123
 
cc8985df
 ## Why?
 1. Building a Jekyll blog from scratch is a lot of work.
 2. Jekyll doesn't have default layouts or themes.
 3. Most developers don't want to do design.
58d342b5
 
cc8985df
 ## Octopress is made of
58d342b5
 - [Jekyll](http://github.com/henrik/jekyll) a blog aware static site generator (Henrik's fork adds [HAML](http://haml-lang.com) support)
1b484123
 - [Compass](http://compass-style.org) an awesome [SASS](http://sass-lang.com) framework
 - [FSSM](http://github.com/ttilley/fssm/tree/master) + a rake task, automatically regenerates the blog as you work
58d342b5
 - [Serve](http://github.com/jlong/serve) for live previews of the site while in development
1b484123
 - [Rsync](http://samba.anu.edu.au/rsync/) for easy deployment
58d342b5
 
cc8985df
 ## Setup
833d64e8
 Setup is really simple.
   
 1. Download Octopress: <code>git clone git://github.com/imathis/octopress.git</code>
e5656921
 2. Install required gems:<br/>
     <code>sudo gem install henrik-jekyll compass fssm serve rdiscount compass-colors</code>
833d64e8
 3. Run <code>rake preview</code> to build the site and preview it in a local webserver.
cc8985df
 
ac9addf8
 You'll want to change some settings, so check out the wiki for [Setup & Configurations](http://wiki.github.com/imathis/octopress/configuration).
cc8985df
 
 ## Usage
833d64e8
 Octopress is almost like a front-end for Jekyll. It provides some really handy rake tasks and automation to make blogging as simple as possible. With Octopress you can:
cc8985df
 
833d64e8
 - Preview the site locally with the power of Serve.
 - Automatically regenerate your blog while you work.
 - Generate and deploy with a single command.
1b484123
 
fe3590be
 See the wiki to learn more about [Usage](http://wiki.github.com/imathis/octopress/usage).
1b484123
 
e062eaa7
 ## Third Party Integration
833d64e8
 With search, comments, and analytics, you have no need for a database. This is what makes a statically generated blog possible.
24c5fedc
 
833d64e8
 - Twitter
 - Disqus Comments
 - Google Custom Search
 - Google Analytics
 - Delicious Bookmarks
1b484123
 
fe3590be
 If you already have an account with these services, you can get set up within seconds. Check out the wiki for [Third Party Configuration](http://wiki.github.com/imathis/octopress/third-party-integration) details, and to learn how to setup or remove these services.
1b484123
 
833d64e8
 ## Octopress Style
 - Stylesheets use [SASS](http://sass-lang.com) and [Compass](http://compass-style.org)
 - They're broken up into Layout, Typography, Theme (colors), and Partials
 - Checkout [the wiki](http://wiki.github.com/imathis/octopress/style-customization) for help with customization.
1b484123
 
833d64e8
 ## License
 (The MIT License)
1b484123
 
833d64e8
 Copyright © 2009 Brandon Mathis
cc8985df
 
833d64e8
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
cc8985df
 
833d64e8
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
cc8985df
 
833d64e8
 THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cc8985df
 
833d64e8
 #### If you want to be awesome.
 - Proudly display the 'Powered by Octopress' credit in the footer.
 - Add your site to the wiki so we can watch the community grow.