diff --git a/README.md b/README.md new file mode 100644 index 0000000..f3e9c07 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +See [executable-tutorials](executable-tutorials.org) diff --git a/executable-tutorials.org b/executable-tutorials.org index daff454..6cf79fb 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. @@ -132,5 +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. - -