Skip to content

Commit 55fb151

Browse files
docs: Updating README
Adding more sections
1 parent d7e0f67 commit 55fb151

File tree

2 files changed

+18
-22
lines changed

2 files changed

+18
-22
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ The turtle is represented as an object, and any number of commands can make or m
6868

6969
Last but not least: Get-Turtle lets you run multiple steps of turtle, and is aliased to urtle.
7070

71-
#### Drawing Simple Shapes
71+
72+
### Drawing Squares
7273

7374
<div align='center'>
7475

7576
<img src='./Examples/Square.svg' alt='Square' width='50%' />
7677
</div>
7778

78-
7979
Let's start simple, by drawing a square with a series of commands.
8080

8181
~~~PowerShell
@@ -141,11 +141,7 @@ So our shortest square can be written as:
141141
turtle square 10 | Save-Turtle ./Square.svg
142142
~~~
143143

144-
We can also just say, make a square directly:
145-
146-
~~~PowerShell
147-
New-Turtle | Move-Turtle Square 10 | Save-Turtle ./Square.svg
148-
~~~
144+
### Drawing Other Shapes
149145

150146
We can use the same techniques to construct other shapes.
151147

@@ -177,6 +173,9 @@ Because this Turtle generates SVG, we can also use it to create patterns.
177173
<div align='center'>
178174
<img src='./Examples/HexagonPattern.svg' alt='Hexagon Pattern' width='50%' />
179175
</div>
176+
177+
### Drawing Fractals
178+
180179
Turtle is often used to draw fractals.
181180

182181
Many fractals can be described in something called a [L-System](https://en.wikipedia.org/wiki/L-system) (short for Lindenmayer system)
@@ -270,7 +269,7 @@ Pop-Location
270269
<img src='./Examples/EndlessSnowflake.svg' alt='Endless Snowflake Pattern' width='100%' />
271270
</div>
272271

273-
### Turtles in a PowerShell Workflow
272+
### Turtle GitHub Action
274273

275274
Turtle has a GitHub action, and can be run in a workflow.
276275

README.md.ps1

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,11 @@ The turtle is represented as an object, and any number of commands can make or m
9393
9494
Last but not least: `Get-Turtle` lets you run multiple steps of turtle, and is aliased to `turtle`.
9595
96-
#### Drawing Simple Shapes
96+
"@
97+
98+
@"
99+
100+
### Drawing Squares
97101
98102
<div align='center'>
99103
$(
@@ -104,7 +108,6 @@ $(
104108
<img src='./Examples/Square.svg' alt='Square' width='50%' />
105109
</div>
106110
107-
108111
Let's start simple, by drawing a square with a series of commands.
109112
110113
~~~PowerShell
@@ -180,19 +183,11 @@ turtle square 10 | Save-Turtle ./Square.svg
180183
'@
181184

182185

183-
@'
184-
185-
We can also just say, make a square directly:
186-
187-
~~~PowerShell
188-
New-Turtle | Move-Turtle Square 10 | Save-Turtle ./Square.svg
189-
~~~
190-
'@
191-
192-
193186

194187
@'
195188
189+
### Drawing Other Shapes
190+
196191
We can use the same techniques to construct other shapes.
197192
198193
For example, this builds us a hexagon:
@@ -220,7 +215,6 @@ $null = turtle ('Forward', 10, 'Rotate', 60 * 6) |
220215
</div>
221216
"@
222217

223-
224218
@"
225219
Because this Turtle generates SVG, we can also use it to create patterns.
226220
"@
@@ -269,6 +263,9 @@ $box3 = {
269263
}
270264

271265
@"
266+
267+
### Drawing Fractals
268+
272269
Turtle is often used to draw fractals.
273270
274271
Many fractals can be described in something called a [L-System](https://en.wikipedia.org/wiki/L-system) (short for Lindenmayer system)
@@ -373,7 +370,7 @@ $(
373370

374371
@"
375372
376-
### Turtles in a PowerShell Workflow
373+
### Turtle GitHub Action
377374
378375
Turtle has a GitHub action, and can be run in a workflow.
379376

0 commit comments

Comments
 (0)