summaryrefslogblamecommitdiffstats
path: root/2020/info/14.md
blob: 47fc85704c1d8d09f1a926964e595b77485101fa (plain) (tree)
1
2
3
4
5
6
7
8
9
                      

        





                                                                         
                                                                      
                                         
# 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.