From 745baf3da573db6a57362b539fd44c4f2287de76 Mon Sep 17 00:00:00 2001 From: "Michael B. Sumulong" Date: Tue, 20 Apr 2021 08:59:20 -0400 Subject: [PATCH 1/5] Fix typo --- executable-tutorials.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/executable-tutorials.org b/executable-tutorials.org index daff454..fe3874f 100644 --- a/executable-tutorials.org +++ b/executable-tutorials.org @@ -3,7 +3,7 @@ When building a large and complex software project, you'd like to be able to make a change to the code base and be sure that the software still works as intended. Nowadays, folks use automated tests to check that things work after code changes. -Let's say you're working on a long and complex tutorial for building some kind of software application. At some point, you decide to change something in the middle of the tutorial. Now, how do you know that your tutorial still works? Experienced tutorial writers know that one option is to occasionally go throught the entire tutorial again to make sure that the steps still lead to the expected resultant project. Another option is to rely on readers of the tutorial to report issues after any changes are made. +Let's say you're working on a long and complex tutorial for building some kind of software application. At some point, you decide to change something in the middle of the tutorial. Now, how do you know that your tutorial still works? Experienced tutorial writers know that one option is to occasionally go through the entire tutorial again to make sure that the steps still lead to the expected resultant project. Another option is to rely on readers of the tutorial to report issues after any changes are made. Or, you can make your tutorial executable and unit tested. From 44c78e8ec97e107f2203a145cf287217c008de73 Mon Sep 17 00:00:00 2001 From: dharmatech Date: Tue, 20 Apr 2021 06:16:25 -0700 Subject: [PATCH 2/5] Create README.md --- README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c09f61f --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +See [executable-tutorials.org](executable-tutorials.org) From 449150187e499de2eebee879cf178832de5d1ea2 Mon Sep 17 00:00:00 2001 From: dharmatech Date: Tue, 20 Apr 2021 06:17:27 -0700 Subject: [PATCH 3/5] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c09f61f..f3e9c07 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -See [executable-tutorials.org](executable-tutorials.org) +See [executable-tutorials](executable-tutorials.org) From 4fdc26fa1280ff5e8be79a16a2e81770cbbac76b Mon Sep 17 00:00:00 2001 From: Eduardo Cavazos Date: Wed, 21 Apr 2021 01:30:55 -0700 Subject: [PATCH 4/5] Update executable-tutorials.org --- executable-tutorials.org | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/executable-tutorials.org b/executable-tutorials.org index fe3874f..c8deeba 100644 --- a/executable-tutorials.org +++ b/executable-tutorials.org @@ -133,4 +133,8 @@ If you write an executable tutorial and would like to share your work, feel free If you know of any tutorials written in such a style, also feel free to post these in the discussions. +* Discussion + +[[https://news.ycombinator.com/item?id=26861835][Discussion thread]] on Hacker News + From 13e1db3edf4f6eca04165e6200bc9ed0b9905a9e Mon Sep 17 00:00:00 2001 From: Eduardo Cavazos Date: Wed, 21 Apr 2021 01:34:18 -0700 Subject: [PATCH 5/5] Update executable-tutorials.org --- executable-tutorials.org | 6 ------ 1 file changed, 6 deletions(-) diff --git a/executable-tutorials.org b/executable-tutorials.org index c8deeba..6cf79fb 100644 --- a/executable-tutorials.org +++ b/executable-tutorials.org @@ -132,9 +132,3 @@ It would be nice to target a document format that is richer than standard github If you write an executable tutorial and would like to share your work, feel free to post a link to your work in the [[https://github.com/dharmatech/executable-tutorials/discussions][discussions]]. If you know of any tutorials written in such a style, also feel free to post these in the discussions. - -* Discussion - -[[https://news.ycombinator.com/item?id=26861835][Discussion thread]] on Hacker News - -