diff --git a/README.md b/README.md index 09a158c..904cd1f 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,16 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user * RSS and Atom feeds! * Markdown Support with Code Highlighting provided by [colorize](http://www.cliki.net/colorize). * Currently supports: Common Lisp, Emacs Lisp, Scheme, C, C++, Java, Python, Erlang, Haskell, Obj-C, Diff. -* [Multi-site publishing](http://rmoritz.github.io/articles/coleslaw-multi-site/) support. * A [Plugin API](http://github.com/redline6561/coleslaw/blob/master/docs/plugin-api.md) and [**plugins**](http://github.com/redline6561/coleslaw/blob/master/docs/plugin-use.md) for... - * Comments via Disqus + * Static Pages * Analytics via Google - * Hosting via Github Pages - * Deploying to Amazon S3 - * Using LaTeX (inside pairs of $$) via Mathjax + * Comments via [Disqus](http://disqus.com/) + * Hosting via [Github Pages](https://pages.github.com/), [Heroku](http://heroku.com/), or [Amazon S3](http://aws.amazon.com/s3/) + * Using LaTeX via [Mathjax](http://mathjax.org/) * Using ReStructured Text + * Importing posts from [Wordpress](http://wordpress.org/) * Sitemap generation - * Importing posts from wordpress * There is also a [Heroku buildpack](https://github.com/jsmpereira/coleslaw-heroku) maintained by Jose Pereira. * Example sites: [redlinernotes](http://redlinernotes.com/blog/), [kenan-bolukbasi.log](http://kenanb.com/), and [Nothing Really Matters](http://ironhead.xs4all.nl/). @@ -34,18 +33,18 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user A core goal of *coleslaw* is to be both pleasant to read and easy to hack on and extend. If you want to understand the internals and bend *coleslaw* to do new and interesting things, I strongly encourage you to read the [Hacker's Guide to Coleslaw](https://github.com/redline6561/coleslaw/blob/master/docs/hacking.md). ## Installation -This software should be portable to any conforming Common Lisp implementation but this guide will assume SBCL is installed. Testing has also been done on CCL. +This software should be portable to any conforming Common Lisp implementation but testing is primarily done on [SBCL](http://www.sbcl.org/) and [CCL](http://ccl.clozure.com/). Server side setup: 1. Setup git and create a bare repo as shown [here](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server). -2. Install Lisp and [Quicklisp](http://quicklisp.org/). +2. Install Lisp (we recommend SBCL) and [Quicklisp](http://quicklisp.org/). 3. ```wget -c https://raw.github.com/redline6561/coleslaw/master/examples/single-site.coleslawrc -O ~/.coleslawrc``` # and edit as necessary 4. ```wget -c https://raw.github.com/redline6561/coleslaw/master/examples/example.post-receive -O your-blog.git/hooks/post-receive``` # and edit as necessary 5. ```chmod +x your-blog/.git/hooks/post-receive``` 6. Create or clone your blog repo locally. Add your server as a remote with ```git remote add prod git@my-host.com:path/to/repo.git``` 7. Point the web server of your choice at the symlink /path/to/deploy-dir/.curr/ -Now whenever you push a new commit to the server, coleslaw will update your blog automatically! You may need to git push -u prod master the first time. +Now whenever you push a new commit to the server, coleslaw will update your blog automatically! You may need to `git push -u prod master` the first time. ## The Post Format Coleslaw expects post files to be formatted as follows: