01-step-by-step-tutorial

nightroman · Feb 12, 2024 · aad5545 · aad5545
1 parent 5740ed7
commit aad5545
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/Tasks/01-step-by-step-tutorial/02-add-new-tasks/tea.build.ps1 b/Tasks/01-step-by-step-tutorial/02-add-new-tasks/tea.build.ps1
@@ -7,7 +7,9 @@ Run any task or combinations:
 	Invoke-Build add_tea
 	Invoke-Build add_sugar
 	Invoke-Build boil_water, add_tea, add_sugar
-	Invoke-Build *  # all tasks, sometimes handy
+
+Issue:
+	- the last command "make tea" is rather verbose for the task
 #>
 
 task boil_water {

diff --git a/...ep-tutorial/03-docs-default/tea.build.ps1 → ...ep-tutorial/03-dot-and-docs/tea.build.ps1 b/...ep-tutorial/03-docs-default/tea.build.ps1 → ...ep-tutorial/03-dot-and-docs/tea.build.ps1
@@ -1,14 +1,14 @@
 <#
 New features:
-	- documentation comments `# Synopsis:`
-	- the default task `.`
-
-Show tasks with their details:
-	Invoke-Build ?
+	- the default task `.` is our "make tea"
+	- special comments `# Synopsis:`
 
 Run the default task:
 	Invoke-Build
 	Invoke-Build .
+
+Show the task list:
+	Invoke-Build ?
 #>
 
 # Synopsis: Boils a pot of water.

diff --git a/Tasks/01-step-by-step-tutorial/README.md b/Tasks/01-step-by-step-tutorial/README.md
@@ -2,13 +2,13 @@
 
 Composing build scripts is incremental process, from small to complex, gradually adding tasks and features.
 
-This tutorial guides from the "Hello world" to some relatively featured build script.
+This tutorial guides from "Hello world" to some featured build script.
 
-The objective is "making tea" with tasks like boiling water, adding tea and sugar.
+Contrived tasks: "making tea", boiling water, adding tea, sugar.
 
 - [01-script-and-task](01-script-and-task)
 - [02-add-new-tasks](02-add-new-tasks)
-- [03-docs-default](03-docs-default)
+- [03-dot-and-docs](03-dot-and-docs)
 - [04-variables](04-variables)
 - [05-references](05-references)
 - [06-parameters](06-parameters)