diff options
Diffstat (limited to '2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv')
| -rw-r--r-- | 2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv b/2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv index 6435d778..506a26eb 100644 --- a/2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv +++ b/2020/subtitles/emacsconf-2020--14-readme-driven-design--adam-ard-autogen.sbv @@ -2,7 +2,7 @@ hello 0:00:04.400,0:00:08.400 -welcome to readme driven design in emacs +welcome to readme driven design in Emacs 0:00:06.560,0:00:10.800 by adam aard @@ -41,7 +41,7 @@ which lets you generate your source code and markdown documentation dynamically 0:00:31.840,0:00:37.120 -i want to walk you through a little bit +I want to walk you through a little bit 0:00:34.719,0:00:39.440 of what this looks like @@ -80,10 +80,10 @@ code snippets to-do lists time tracking and much more 0:01:03.520,0:01:07.760 -i'm going to drop in some documentation +I'm going to drop in some documentation 0:01:05.360,0:01:10.840 -that i r that i've written about +that I r that I've written about 0:01:07.760,0:01:12.240 about my project here so you can kind of @@ -95,7 +95,7 @@ see what this would look like 0:01:15.280,0:01:20.320 -so as you can see i have a title and a +so as you can see I have a title and a 0:01:17.119,0:01:23.840 description and then a sub section @@ -119,7 +119,7 @@ it's good or it's as good or better than markdown 0:01:35.040,0:01:38.880 -but when you use it in the emacs you can +but when you use it in the Emacs you can 0:01:37.520,0:01:40.479 do a lot more @@ -176,16 +176,16 @@ literate programming so take a quick look at this diagram 0:02:21.440,0:02:25.360 -that i generated here +that I generated here 0:02:23.200,0:02:27.520 -and gives you a quick overview of what i +and gives you a quick overview of what I 0:02:25.360,0:02:31.200 mean by literate programming 0:02:27.520,0:02:33.920 -and how i'm using it you can see +and how I'm using it you can see 0:02:31.200,0:02:34.720 that we start with a readme.org file on @@ -254,7 +254,7 @@ so let's dig in to the details of how this works 0:03:22.640,0:03:26.159 -and i hope you hopefully you'll see how +and I hope you hopefully you'll see how 0:03:24.560,0:03:28.959 cool this is @@ -284,7 +284,7 @@ environment is set up correctly so let's get started with a code block 0:03:47.120,0:03:50.319 -so i created a little snippet to help me +so I created a little snippet to help me 0:03:49.519,0:03:52.239 add @@ -338,7 +338,7 @@ the tangling is uh done in the tangle step versus the 0:04:37.600,0:04:41.199 -weave step and i'll explain that a +weave step and I'll explain that a 0:04:39.280,0:04:45.199 little bit more but the tangle @@ -347,7 +347,7 @@ little bit more but the tangle field just simply tells tells uh 0:04:45.199,0:04:50.320 -emacs where it needs to generate the +Emacs where it needs to generate the 0:04:48.320,0:04:53.280 main.go file and where it needs to put @@ -362,7 +362,7 @@ uh you'll you'll notice that we we're going to use go 0:04:59.040,0:05:02.160 -that's just the language that i've been +that's just the language that I've been 0:05:01.440,0:05:05.360 using @@ -410,7 +410,7 @@ generate the basics of a go program 0:05:36.560,0:05:39.840 -so i'm just going to print +so I'm just going to print 0:05:40.240,0:05:42.960 hello world @@ -443,7 +443,7 @@ language specific buffer by typing control c single quote 0:06:07.680,0:06:12.160 -so you can see now i have a a go a +so you can see now I have a a go a 0:06:10.240,0:06:14.240 buffer that's in go mode @@ -512,7 +512,7 @@ separate file and that's the tangle process that you 0:06:57.440,0:07:03.360 -you need to follow there so i'm gonna +you need to follow there so I'm gonna 0:07:01.360,0:07:05.280 drop in a little bit more doc a little @@ -527,25 +527,25 @@ documentation really quick here okay all right so just kind of as a 0:07:17.360,0:07:24.800 -kind of as a side note i like to follow +kind of as a side note I like to follow 0:07:21.520,0:07:26.639 this process uh whenever having whenever 0:07:24.800,0:07:28.880 -i have an operation to perform i +I have an operation to perform I 0:07:26.639,0:07:31.680 -i'd like to document it here with a +I'd like to document it here with a 0:07:28.880,0:07:33.280 snippet that can be executed in line 0:07:31.680,0:07:34.639 -then i don't have to leave org mode and +then I don't have to leave org mode and 0:07:33.280,0:07:36.800 -i don't have to try to remember what i +I don't have to try to remember what I 0:07:34.639,0:07:38.960 did later so instead of just @@ -554,7 +554,7 @@ did later so instead of just trying to do an operation the first time 0:07:38.960,0:07:41.680 -i do something i take the +I do something I take the 0:07:40.319,0:07:43.440 take the time to figure out what it is @@ -662,7 +662,7 @@ these operations that we're going to perform 0:09:00.160,0:09:03.920 -so i'm dropping in a +so I'm dropping in a 0:09:04.560,0:09:11.200 a build instruction section and a run @@ -692,7 +692,7 @@ the file that gets generated should be called demo 0:09:30.080,0:09:34.000 -and uh so we just run it here so if if i +and uh so we just run it here so if if I 0:09:32.959,0:09:37.839 type control c @@ -791,7 +791,7 @@ we need to do add some sections that will cause uh 0:11:02.959,0:11:06.720 -emacs to have to to tangle or assemble +Emacs to have to to tangle or assemble 0:11:06.320,0:11:09.760 this @@ -872,13 +872,13 @@ we want to add some functionality that makes our program say hello 0:12:12.720,0:12:17.600 -so using a different snippet that i have +so using a different snippet that I have 0:12:15.680,0:12:20.800 for creating something 0:12:17.600,0:12:24.079 -that i call like a literate section +that I call like a literate section 0:12:20.800,0:12:26.000 um basically we create a @@ -920,7 +920,7 @@ and this ties that slot basically to this reference it tells 0:12:51.120,0:12:56.880 -emacs that when you tangle +Emacs that when you tangle 0:12:53.760,0:12:58.240 we want to stick whatever's in here in @@ -980,7 +980,7 @@ just print something but let's just say hello 0:13:41.360,0:13:49.519 -emacs comp this time +Emacs comp this time 0:13:45.760,0:13:51.040 okay so now we have a function and now @@ -1022,7 +1022,7 @@ the sections that we want to get tangled or inserted 0:14:21.360,0:14:27.199 -so i i've kind of used this syntax +so I I've kind of used this syntax 0:14:25.440,0:14:28.560 it's it's kind of borrowed from @@ -1034,7 +1034,7 @@ literature programming a little bit with a plus equals so really it's just saying 0:14:30.320,0:14:35.760 -that i want to append +that I want to append 0:14:32.480,0:14:37.600 this item into the import section so @@ -1061,7 +1061,7 @@ annotations and so you won't know immediately that this section goes in 0:14:51.440,0:14:55.440 -the imports area and so i usually put +the imports area and so I usually put 0:14:53.839,0:14:57.760 a little bit of documentation on top @@ -1214,16 +1214,16 @@ and then if we did this right when we when we run this we should get hello 0:16:45.600,0:16:51.199 -emacs comp so ctrl c +Emacs comp so ctrl c 0:16:47.199,0:16:54.800 -ctrl c hello emacs comp +ctrl c hello Emacs comp 0:16:51.199,0:16:57.120 -so i uh +so I uh 0:16:54.800,0:16:58.240 -i think that's pretty pretty cool +I think that's pretty pretty cool 0:16:57.120,0:17:00.160 actually so we've got @@ -1265,10 +1265,10 @@ documenting further the last piece that we need to 0:17:27.120,0:17:34.799 -take care of is the weave that i +take care of is the weave that I 0:17:30.559,0:17:38.640 -that's i showed you in the diagram above +that's I showed you in the diagram above 0:17:34.799,0:17:41.760 so one more time we'll drop in @@ -1334,13 +1334,13 @@ now you can see that it's generated some documentation 0:18:35.520,0:18:39.679 -it puts a index at top at the top i +it puts a index at top at the top I 0:18:38.320,0:18:42.000 usually just 0:18:39.679,0:18:43.679 -i usually turn that off it's easy to do +I usually turn that off it's easy to do 0:18:42.000,0:18:44.559 that by putting a property at the top of @@ -1406,19 +1406,19 @@ hopefully that makes more sense now but now you can see all the documentation 0:19:22.240,0:19:29.919 -and i think it demonstrates a +and I think it demonstrates a 0:19:26.080,0:19:33.520 pretty useful feature that's inside of 0:19:29.919,0:19:35.039 -emacs and and hopefully +Emacs and and hopefully 0:19:33.520,0:19:39.840 hopefully you'll have as much fun using 0:19:35.039,0:19:39.840 -that as i have +that as I have 0:19:39.919,0:19:43.600 so thanks |