summaryrefslogtreecommitdiffstats
path: root/2020/info/14.md
blob: a55e1f47ba12e95cdd44e7e4c4b83c27191b27fb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
# README-Driven Design
Adam Ard

Many source code projects these days begin with a README file. While most
people use markdown, if you use org-mode you can use literate programming
to generate all of your source code directly from the documentation.

This strategy is a great way to keep your documentation from getting
outdated, and it allows you to use all the other wonderful features of
org-mode. Watch "README Driven Design," to see exactly how to make your
README file a powerful literate document.