From 673d3bab808674148654ebb8d5f2eb437348e1f4 Mon Sep 17 00:00:00 2001 From: Sacha Chua Date: Tue, 10 Nov 2020 22:49:41 -0500 Subject: Tweak README-Driven Design description --- 2020/info/14.md | 2 +- 2020/submissions.md | 120 ++++++++++++++++++++++----------------------------- 2020/submissions.org | 32 ++++---------- 3 files changed, 61 insertions(+), 93 deletions(-) diff --git a/2020/info/14.md b/2020/info/14.md index a55e1f47..47fc8570 100644 --- a/2020/info/14.md +++ b/2020/info/14.md @@ -7,5 +7,5 @@ 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 +org-mode. Watch "README-Driven Design" to see exactly how to make your README file a powerful literate document. diff --git a/2020/submissions.md b/2020/submissions.md index 5a09b927..21d09dfb 100644 --- a/2020/submissions.md +++ b/2020/submissions.md @@ -7,32 +7,32 @@ You can check out the Org Mode source for this page by following the [editing in # Table of Contents -- [Actions](#org46d1a44) -- [Tables](#org48f0fff) - - [Overall](#org1b79c1a) - - [By slot](#orgc706356) - - [Saturday](#org1062f77) - - [Sunday](#org1765449) - - [Table for all talks](#org952919d) -- [Talks](#org4648599) - - [NOVEMBER 28 (Saturday)](#org458a793):sat: - - [9:00 - 9:30 Opening remarks](#org3e8be92) - - [9:30 - 12:00 User talks](#org0ae6710):morning: - - [12:00 - 13:00 Lunch](#org42d0c78) - - [13:00 - 16:30 Afternoon talks](#org7fb22ea):afternoon: - - [16:30 - 17:00 Closing remarks](#orga9c5a06) - - [NOVEMBER 29 (Sunday)](#orgf72903b):sun: - - [9:00 - 9:10 Opening remarks](#orgd6daa72) - - [9:10 - 12:00 Morning talks](#org8512848):morning: - - [12:00 - 13:00 Lunch](#org20510d0) - - [13:00 - 16:30 Afternoon talks](#org3b7bf07):afternoon: - - [16:30 - 17:00 Closing remarks](#orgf450002) +- [Actions](#org7d8cc77) +- [Tables](#orgc89dd54) + - [Overall](#orgf9d7f69) + - [By slot](#org33f7445) + - [Saturday](#org2518c70) + - [Sunday](#org45ee756) + - [Table for all talks](#org7e5fd50) +- [Talks](#orgd54b98f) + - [NOVEMBER 28 (Saturday)](#org68ef6fa):sat: + - [9:00 - 9:30 Opening remarks](#org6a91418) + - [9:30 - 12:00 User talks](#org7f8e774):morning: + - [12:00 - 13:00 Lunch](#org49ea1ed) + - [13:00 - 16:30 Afternoon talks](#orga750a7a):afternoon: + - [16:30 - 17:00 Closing remarks](#org56c93c0) + - [NOVEMBER 29 (Sunday)](#orgea7cab9):sun: + - [9:00 - 9:10 Opening remarks](#orgaa9ea5c) + - [9:10 - 12:00 Morning talks](#org5bba0d4):morning: + - [12:00 - 13:00 Lunch](#orgaaf69b1) + - [13:00 - 16:30 Afternoon talks](#org405c07d):afternoon: + - [16:30 - 17:00 Closing remarks](#orgbfc2b3a) - [Code](#talk37) - - [Planning](#orgf5de6c2) - - [Generate schedule file](#org9c7b0ca) + - [Planning](#org70194b9) + - [Generate schedule file](#orgb231870) - + # Actions @@ -45,12 +45,12 @@ To update the information included in the individual talk page, execute the buffer, update the talk's info/TALKID.md file. - + # Tables - + ## Overall @@ -182,12 +182,12 @@ execute the buffer, update the talk's info/TALKID.md file. - + ## By slot - + ### Saturday @@ -437,7 +437,7 @@ execute the buffer, update the talk's info/TALKID.md file. - + ### Sunday @@ -642,7 +642,7 @@ execute the buffer, update the talk's info/TALKID.md file. - + ## Table for all talks @@ -966,22 +966,22 @@ execute the buffer, update the talk's info/TALKID.md file. - + # Talks - + ## NOVEMBER 28 (Saturday) :sat: - + ### 9:00 - 9:30 Opening remarks - + ### 9:30 - 12:00 User talks :morning: @@ -1718,12 +1718,12 @@ execute the buffer, update the talk's info/TALKID.md file. fair use. - + ### 12:00 - 13:00 Lunch - + ### 13:00 - 16:30 Afternoon talks :afternoon: @@ -2209,30 +2209,14 @@ execute the buffer, update the talk's info/TALKID.md file. - 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 @@ -2639,22 +2623,22 @@ execute the buffer, update the talk's info/TALKID.md file. fair use. - + ### 16:30 - 17:00 Closing remarks - + ## NOVEMBER 29 (Sunday) :sun: - + ### 9:00 - 9:10 Opening remarks - + ### 9:10 - 12:00 Morning talks :morning: @@ -3066,12 +3050,12 @@ execute the buffer, update the talk's info/TALKID.md file. TBD - plans for a NonGNU ELPA that will be easy to enable and contribute to without signing copyright assignment papers - + ### 12:00 - 13:00 Lunch - + ### 13:00 - 16:30 Afternoon talks :afternoon: @@ -3835,7 +3819,7 @@ execute the buffer, update the talk's info/TALKID.md file. fair use. - + ### 16:30 - 17:00 Closing remarks @@ -3903,7 +3887,7 @@ fair use. # Code - + ## Planning @@ -4005,7 +3989,7 @@ Some conference-related functions (lambda () (org-entry-get (point) "MIN_TIME")) nil 'tree)))))))) - + ## Generate schedule file 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 -- cgit v1.2.3