From 8a507e33ec0da51699e19ff38fc320d7b3ed0fa0 Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Tue, 15 Apr 2014 22:27:35 -0400 Subject: [PATCH] Add reference to hacking docs to README. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 623a8a5..09a158c 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,10 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user * 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/). +## Hacking + +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. Server side setup: