From 870e8d04e822543c4e918c3400fb8b22f6a1d52e Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Wed, 29 Aug 2012 14:58:49 -0400 Subject: [PATCH] README tweaks. --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8ce1da3..6fbd31a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # coleslaw -Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll. Coleslaw was a nickname of my favorite poet [Czeslaw Milosz](http://blog.redlinernotes.com/tag/milosz.html). +coleslaw logo -# Features +> [Czeslaw Milosz](http://blog.redlinernotes.com/tag/milosz.html) was the writer-in-residence at UNC c. 1992. +> I used to see him all the time at the Hardback Cafe, always sitting at a two-top +> drinking coffee, reading, writing, eating chips and salsa. I remember a gentleness +> behind the enormous bushy eyebrows and that we called him Coleslaw. - anon + +Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll. + +## Features * Git for storage * RSS feeds! * Markdown Support with Code Highlighting provided by [colorize](http://www.cliki.net/colorize). @@ -12,7 +19,7 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user * Use LaTeX (inside pairs of $$) via Mathjax * Import from wordpress -# Installation +## 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. Server side setup: @@ -23,11 +30,11 @@ Server side setup: 5. ```cp coleslaw/example.post-receieve your-blog.git/hooks/post-receive``` # and edit as necessary 6. ```chmod +x your-blog/.git/hooks/post-receive``` 7. 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``` -8. The only thing left to do is point a web server of your choice at the symlink /path/to/deploy-dir/.curr/ +8. 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. -# The Post Format +## The Post Format Coleslaw expects post files to be formatted as follows: ``` ;;;;; @@ -39,7 +46,7 @@ format: html (for raw html) or md (for markdown) your post ``` -# Importing from Wordpress +## Importing from Wordpress There is a "plugin" to import from wordpress. At some point, it should be turned into a standalone script. Until then... 1. Export your posts from wordpress. @@ -51,9 +58,9 @@ There is a "plugin" to import from wordpress. At some point, it should be turned The XML will be read and placed into .post files in the :repo location specified in your [.coleslawrc](http://github.com/redline6561/coleslaw/blob/master/example.coleslawrc). -# Writing your own plugins -For now, see the [API](http://redlinernotes.com/docs/coleslaw.html) the [mathjax plugin](https://github.com/redline6561/coleslaw/blob/master/plugins/mathjax.lisp) for an example. -A proper guide about this should be written later. +## Writing your own plugins +For now, see the [API](http://redlinernotes.com/docs/coleslaw.html) and the [mathjax plugin](https://github.com/redline6561/coleslaw/blob/master/plugins/mathjax.lisp) for an example. +A proper guide about this will be written later. -# Theming +## Theming A default theme, hyde, is provided. Themes are made using Google's closure-template and the source for [hyde](https://github.com/redline6561/coleslaw/tree/master/themes/hyde) should be simple and instructive until I can provide better docs.