瀏覽代碼

Add reference to hacking docs to README.

Brit Butler 11 年之前
父節點
當前提交
8a507e33ec
共有 1 個文件被更改,包括 4 次插入0 次删除
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -29,6 +29,10 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user
29 29
 * There is also a [Heroku buildpack](https://github.com/jsmpereira/coleslaw-heroku) maintained by Jose Pereira.
30 30
 * Example sites: [redlinernotes](http://redlinernotes.com/blog/), [kenan-bolukbasi.log](http://kenanb.com/), and [Nothing Really Matters](http://ironhead.xs4all.nl/).
31 31
 
32
+## Hacking
33
+
34
+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).
35
+
32 36
 ## Installation
33 37
 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.
34 38
 Server side setup: