Skip to content

Commit c5c9f25

Browse files
dusanodusano
committed
Fixing the tutorial.
1 parent 33dbdc3 commit c5c9f25

File tree

1 file changed

+47
-50
lines changed

1 file changed

+47
-50
lines changed

‎install/walkthrough.sh‎

Lines changed: 47 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ NC="${NC:-\033[0m}"
1313
# Onboarding Step 1: Introduction to Plain
1414
clear
1515
echo ""
16-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
17-
echo -e " ${YELLOW}${BOLD}quick intro to ***plain specification language${NC} - Step 1 of 5"
18-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
16+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
17+
echo -e " ${YELLOW}${BOLD}***plain specification language intro${NC} - Step 1 of 5"
18+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
1919
echo ""
20-
echo -e " ***plain is a language of spec-driven development that allows developers to express intent on any level of detail."
20+
echo -e " ***plain is a language of spec-driven development that allows developers to express intent at any level of detail."
2121
echo ""
22-
echo -e " write specs in ${YELLOW}plain English${NC}, in markdown with additional syntax"
22+
echo -e " write specs in natural language extended with additional syntax based on markdown."
2323
echo ""
2424
echo -e " render production-ready code with *codeplain."
2525
echo ""
@@ -28,8 +28,8 @@ echo ""
2828
echo -e "${GRAY} ┌────────────────────────────────────────────────────────┐${NC}"
2929
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
3030
echo -e "${GRAY} │${NC} ${YELLOW}***definitions***${NC} - key concepts in your app ${GRAY}│${NC}"
31-
echo -e "${GRAY} │${NC} ${YELLOW}***implementation reqs***${NC} - implementation details ${GRAY}│${NC}"
32-
echo -e "${GRAY} │${NC} ${YELLOW}***test reqs***${NC} - testing requirements ${GRAY}│${NC}"
31+
echo -e "${GRAY} │${NC} ${YELLOW}***implementation reqs***${NC} - implementation details ${GRAY}│${NC}"
32+
echo -e "${GRAY} │${NC} ${YELLOW}***test reqs***${NC} - testing requirements ${GRAY}│${NC}"
3333
echo -e "${GRAY} │${NC} ${YELLOW}***functional specs***${NC} - what the app should do ${GRAY}│${NC}"
3434
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
3535
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
@@ -41,33 +41,32 @@ read -r -p " press [Enter] to continue..." < /dev/tty
4141
# Onboarding Step 2: Functional Specification
4242
clear
4343
echo ""
44-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
45-
echo -e " ${YELLOW}${BOLD}Plain Language 101${NC} - Step 2 of 5"
46-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
44+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
45+
echo -e " ${YELLOW}${BOLD}***plain specification language intro${NC} - Step 2 of 5"
46+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
4747
echo ""
4848
echo -e " ${WHITE}${BOLD}FUNCTIONAL SPECS${NC} - what should the app do?"
4949
echo ""
5050
echo -e " This is where you describe ${GREEN}what your app should do${NC},"
51-
echo -e " written in plain English. No code, just requirements."
51+
echo -e " written in natural language. No code, just requirements."
5252
echo ""
5353
echo -e "${GRAY} ┌────────────────────────────────────────────────────────┐${NC}"
5454
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
55-
echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC} ${GRAY}│${NC}"
55+
echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC} ${GRAY}│${NC}"
5656
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
57-
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
57+
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
5858
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
59-
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
59+
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
6060
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
61-
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
62-
echo -e "${GRAY} │${NC} ${GRAY}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
61+
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
6362
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
64-
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
63+
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
6564
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
66-
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
65+
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use pytest.${NC} ${GRAY}│${NC}"
6766
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
68-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***functional specs***${NC} ${GRAY}│${NC}"
67+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***functional specs***${NC} ${GRAY}│${NC}"
6968
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
70-
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
69+
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
7170
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
7271
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
7372
echo ""
@@ -79,47 +78,46 @@ read -r -p " press [Enter] to continue..." < /dev/tty
7978
# Onboarding Step 3: Definitions
8079
clear
8180
echo ""
82-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
83-
echo -e " ${YELLOW}${BOLD}Plain Language 101${NC} - Step 3 of 5"
84-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
81+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
82+
echo -e " ${YELLOW}${BOLD}***plain specification language intro${NC} - Step 3 of 5"
83+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
8584
echo ""
86-
echo -e " ${WHITE}${BOLD}DEFINITIONS${NC} - identify key concepts"
85+
echo -e " ${WHITE}${BOLD}DEFINITIONS${NC} - definitions and descriptions of key concepts"
8786
echo ""
88-
echo -e " Define ${GREEN}reusable concepts${NC} with the ${YELLOW}:ConceptName:${NC} syntax."
87+
echo -e " Define ${GREEN}reusable concepts${NC} using the ${YELLOW}:Concept:${NC} notation."
8988
echo -e " These become building blocks you can reference anywhere."
9089
echo ""
9190
echo -e "${GRAY} ┌────────────────────────────────────────────────────────┐${NC}"
9291
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
93-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***definitions***${NC} ${GRAY}│${NC}"
92+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***definitions***${NC} ${GRAY}│${NC}"
9493
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
95-
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :App: is a console application.${NC} ${GRAY}│${NC}"
94+
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :App: is a console application.${NC} ${GRAY}│${NC}"
9695
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
97-
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
96+
echo -e "${GRAY} │${NC} ${GRAY}***implementation reqs***${NC} ${GRAY}│${NC}"
9897
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
99-
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
100-
echo -e "${GRAY} │${NC} ${GRAY}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
98+
echo -e "${GRAY} │${NC} ${GRAY}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
10199
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
102-
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
100+
echo -e "${GRAY} │${NC} ${GRAY}***test reqs***${NC} ${GRAY}│${NC}"
103101
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
104-
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
102+
echo -e "${GRAY} │${NC} ${GRAY}- :ConformanceTests: should use pytest.${NC} ${GRAY}│${NC}"
105103
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
106-
echo -e "${GRAY} │${NC} ${GRAY}***functional specs***${NC} ${GRAY}│${NC}"
104+
echo -e "${GRAY} │${NC} ${GRAY}***functional specs***${NC} ${GRAY}│${NC}"
107105
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
108-
echo -e "${GRAY} │${NC} ${GRAY}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
106+
echo -e "${GRAY} │${NC} ${GRAY}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
109107
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
110108
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
111109
echo ""
112-
echo -e " ${GREEN}▲${NC} The ${YELLOW}:App:${NC} concept is defined once and used throughout."
110+
echo -e " ${GREEN}▲${NC} The ${YELLOW}:App:${NC} concept is defined once and used throughout the specs."
113111
echo -e " Concepts help keep your specs consistent and clear."
114112
echo ""
115113
read -r -p " press [Enter] to continue..." < /dev/tty
116114

117115
# Onboarding Step 4: Implementation & Test Reqs
118116
clear
119117
echo ""
120-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
121-
echo -e " ${YELLOW}${BOLD}Plain Language 101${NC} - Step 4 of 5"
122-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
118+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
119+
echo -e " ${YELLOW}${BOLD}***plain specification language intro${NC} - Step 4 of 5"
120+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
123121
echo ""
124122
echo -e " ${WHITE}${BOLD}IMPLEMENTATION & TEST REQS${NC} - how to implement and test"
125123
echo ""
@@ -128,22 +126,21 @@ echo -e " This guides how the code should be generated and verified."
128126
echo ""
129127
echo -e "${GRAY} ┌────────────────────────────────────────────────────────┐${NC}"
130128
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
131-
echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC} ${GRAY}│${NC}"
129+
echo -e "${GRAY} │${NC} ${GRAY}***definitions***${NC} ${GRAY}│${NC}"
132130
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
133-
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
131+
echo -e "${GRAY} │${NC} ${GRAY}- :App: is a console application.${NC} ${GRAY}│${NC}"
134132
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
135-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***implementation reqs***${NC} ${GRAY}│${NC}"
133+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***implementation reqs***${NC} ${GRAY}│${NC}"
136134
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
137-
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
138-
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :UnitTests: should use Unittest framework.${NC} ${GRAY}│${NC}"
135+
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :Implementation: should be in Python.${NC} ${GRAY}│${NC}"
139136
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
140-
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***test reqs***${NC} ${GRAY}│${NC}"
137+
echo -e "${GRAY} │${NC} ${YELLOW}${BOLD}***test reqs***${NC} ${GRAY}│${NC}"
141138
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
142-
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :ConformanceTests: should use Unittest.${NC} ${GRAY}│${NC}"
139+
echo -e "${GRAY} │${NC} ${GREEN}${BOLD}- :ConformanceTests: should use pytest.${NC} ${GRAY}│${NC}"
143140
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
144-
echo -e "${GRAY} │${NC} ${GRAY}***functional specs***${NC} ${GRAY}│${NC}"
141+
echo -e "${GRAY} │${NC} ${GRAY}***functional specs***${NC} ${GRAY}│${NC}"
145142
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
146-
echo -e "${GRAY} │${NC} ${GRAY}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
143+
echo -e "${GRAY} │${NC} ${GRAY}- :App: should display \"hello, world\".${NC} ${GRAY}│${NC}"
147144
echo -e "${GRAY} │${NC} ${GRAY}│${NC}"
148145
echo -e "${GRAY} └────────────────────────────────────────────────────────┘${NC}"
149146
echo ""
@@ -155,9 +152,9 @@ read -r -p " press [Enter] to continue..." < /dev/tty
155152
# Onboarding Step 5: Rendering Code
156153
clear
157154
echo ""
158-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
159-
echo -e " ${YELLOW}${BOLD}Plain Language 101${NC} - Step 5 of 5"
160-
echo -e "${GRAY}────────────────────────────────────────────${NC}"
155+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
156+
echo -e " ${YELLOW}${BOLD}***plain specification language intro${NC} - Step 5 of 5"
157+
echo -e "${GRAY}─────────────────────────────────────────────────────────${NC}"
161158
echo ""
162159
echo -e " ${WHITE}${BOLD}RENDERING CODE${NC} - generate your app"
163160
echo ""

0 commit comments

Comments
 (0)