diff options
| author | Sacha Chua <sacha@sachachua.com> | 2020-11-10 22:49:41 -0500 |
|---|---|---|
| committer | Sacha Chua <sacha@sachachua.com> | 2020-11-10 22:49:41 -0500 |
| commit | 673d3bab808674148654ebb8d5f2eb437348e1f4 (patch) | |
| tree | 2ac58dc183daa17458f14dc94c549dfad580f981 /2020/submissions.org | |
| parent | b08fc8cd8dcaab2b6fd2c346e5801984a1f33b2c (diff) | |
| download | emacsconf-wiki-673d3bab808674148654ebb8d5f2eb437348e1f4.tar.xz emacsconf-wiki-673d3bab808674148654ebb8d5f2eb437348e1f4.zip | |
Tweak README-Driven Design description
Diffstat (limited to '2020/submissions.org')
| -rw-r--r-- | 2020/submissions.org | 32 |
1 files changed, 8 insertions, 24 deletions
diff --git a/2020/submissions.org b/2020/submissions.org index 8ddc2f7b..583f9415 100644 --- a/2020/submissions.org +++ b/2020/submissions.org @@ -1296,30 +1296,14 @@ My schedule is wide open too, so put me in at any time slot. ***** Talk information -Org mode, among its numerous features, has the ability to do full -literate programming (with tangling and weaving the way Donald Knuth -originally intended). As a programmer, you can work comfortably, -completely inside an org-mode buffer. When you are ready, emacs will -generate the appropriate documentation and source code files for you. -If you are a lone emacs user on your project, simply commit these -exported files and keep your org file to yourself -- no one is the -wiser. - -Watch "README-Driven Design" to learn how you can -annotate code snippets in an org file so they can be automatically -exported to their proper locations in your source tree. Keep -important information about your project where it should be: right -next to the code itself. Not as ugly, out-of-date notes sitting -behind comment characters in your source files, but front and center -in well-formatted markdown and pdf files. - -And, for advanced use cases, see how you can even use a full-fledged -macro processor like m4 to personalize your workflow even more. -Literate programming on steroids! - -I'll walk you through the whole process, starting from an empty -project README.org to a simple example that generates source and -documentation. +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. ***** (Un)availability |