summaryrefslogtreecommitdiffstats
path: root/posts/Literate_emacs_init.mdwn
blob: dda508091f3f290a3da591de005fc6b203075682 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
A little while back I saw
[Sacha Chua](http://sachachua.com/blog/2012/05/where-i-am-in-terms-of-emacs/)
mention using `org-mode` for literate programming. I'd heard of
literate programming, but its use escaped me. Still, reading that and
looking at what `noweb` is I started thinking that it would indeed be
a great way of documenting code, especially something like my emacs
init file, since that is not a serious software project and some weird
stuff goes on in there.

I still didn't really get the hang of it. It seemed like a lot of work
to get into it and how exactly it fit together with using `org-mode`
didn't really hit me so I pushed it aside for the moment.

Today I see her
[presenting](http://sachachua.com/blog/2012/06/literate-programming-emacs-configuration-file/)
her new literately programmed init file with some links to other
resources and I just had to try it too.

I haven't gotten very far yet, but what I have so far I have put
[here](http://ryuslash.org/inittest.html). It's just the generated
HTML file, no org source, and I'm still messing around with the colors
and stuff, but it's fun to see the result already.

I don't know if I'm actually going to use it, since my init file's
sloc count is 1038 and its total line count is 1280 lines I fear that
adding even more documentation (= lines) would make my init file
**very** bulky. It is still fun to see and experiment with, though.

[[!meta date="2012-06-09 01:19:00"]]
[[!tag emacs literate_programming org-mode]]