Skip to content

Commit b2e00b6

Browse files
authored
🎨 Add Images to README.md (#354)
* 🎨 📝 Add pictures to README.md * ♻️ Add short names for image paths * ♻️ Move logos into Images Also added named links to readme for different logos (some are unused). * ♻️ Move remaining inline links to refs
1 parent c450201 commit b2e00b6

File tree

7 files changed

+35
-78
lines changed

7 files changed

+35
-78
lines changed

README.md

Lines changed: 35 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# PowerShell Koans
22

3-
| | Build Status |
4-
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------- |
5-
| [![PSKoans Logo](./logo-64px.png)](./logo.svg) | [![Build Status][build-badge]][build-link]<br/>[![Coverage Status][coverage-badge]][build-link] |
3+
| | Build Status |
4+
| ------------------------------------ | ----------------------------------------------------------------------------------------------- |
5+
| [![PSKoans Logo][logo-64]][logo-svg] | [![Build Status][build-badge]][build-link]<br/>[![Coverage Status][coverage-badge]][build-link] |
66

77
- [PowerShell Koans](#powershell-koans)
88
- [About the Author](#about-the-author)
@@ -24,13 +24,13 @@
2424

2525
### Joel Sallow
2626

27-
- [Blog](https://vexx32.github.io)
28-
- [Twitter](https://twitter.com/vexx32)
27+
- [Blog][blog]
28+
- [Twitter][twitter]
2929

3030
## Synopsis
3131

32-
Inspired by Chris Marinos' **fantastic** [F# koans](https://github.com/ChrisMarinos/FSharpKoans), the goal of the PowerShell koans is to teach you PowerShell by presenting you with a set of questions.
33-
Each [kōan](https://en.wikipedia.org/wiki/K%C5%8Dan) (each question) is represented by a failing Pester test.
32+
Inspired by Chris Marinos' **fantastic** [F# koans][fsharp-koans], the goal of the PowerShell koans is to teach you PowerShell by presenting you with a set of questions.
33+
Each [kōan][define-koan] (each question) is represented by a failing Pester test.
3434
Your goal is to make those tests pass by filling out the correct answer, or writing the correct code.
3535
The koans start very simple to get you familiar with the basic concepts and progress towards more difficult.
3636
Teaching you multiple beginner, intermediate and advanced aspects of PowerShell in the process.
@@ -39,7 +39,7 @@ To get started please navigate to [prerequisites](#prerequisites) and [getting s
3939

4040
## Command Reference
4141

42-
View the PSKoans [Command Reference Documentation](docs/PSKoans.md).
42+
View the PSKoans [Command Reference Documentation][reference-docs].
4343

4444
## Prerequisites
4545

@@ -85,42 +85,13 @@ Install-Module PSKoans -Scope CurrentUser
8585

8686
You will be presented with a page describing your goal:
8787

88-
```code
89-
Welcome, seeker of enlightenment.
90-
Please wait a moment while we examine your karma...
91-
92-
Describing 'Equality' has damaged your karma.
93-
94-
You have not yet reached enlightenment.
95-
96-
The answers you seek...
97-
98-
Expected $true, but got $null.
99-
100-
Please meditate on the following code:
101-
102-
× It is a simple comparison
103-
at <ScriptBlock>, C:\Users\Joel\PSKoans\Introduction\AboutAssertions.Koans.ps1: line 27
104-
27: $____ | Should -Be $true
105-
106-
▌ When you smash the citadel of doubt,
107-
▌ Then the Buddha is simply yourself.
108-
109-
You examine the path beneath your feet...
110-
111-
[AboutAssertions]: [――――――――――――――――――――――――――] 0/4
112-
113-
114-
[Total]: [――――――――――――――――――――――――――――――――――――――――――――――――――――] 0/635
115-
116-
Run 'Show-Karma -Meditate' to begin your meditations.
117-
```
88+
![Show-Karma result screen, showing zero completed koans][show-karma-1]
11889

11990
Inspect the red messages carefully, most importantly the last one.
12091
The error message contains path to the file that you need to edit in order to progress forward.
12192
In this case, you'll need to examine `Introduction\AboutAssertions.Koans.ps1`.
12293

123-
### 2. Run `Show-Karma -Meditate` to open your Koans folder
94+
### 2. Run `Show-Karma -Contemplate` to open your Koans folder
12495

12596
Navigate to `Introduction\AboutAssertions.Koans.ps1`. Near the top you'll see:
12697

@@ -139,47 +110,16 @@ To pass this koan you need to replace `$____` with `$true` to fulfil the asserti
139110
You passed your first koan!
140111
You'll notice that your overall progress updated to `1/635` and you are presented with the next challenge.
141112

142-
```code
143-
Welcome, seeker of enlightenment.
144-
Please wait a moment while we examine your karma...
145-
146-
Describing 'Equality' has damaged your karma.
147-
148-
You have not yet reached enlightenment.
149-
150-
The answers you seek...
151-
152-
Expected 3, but got .
153-
154-
Please meditate on the following code:
155-
156-
× It expects you to fill in values
157-
at <ScriptBlock>, C:\Users\Joel\PSKoans\Introduction\AboutAssertions.Koans.ps1: line 32
158-
32: __ | Should -Be (1 + 2)
159-
160-
▌ Grasping nothing, discarding nothing.
161-
▌ In every place there's no hindrance, no conflict.
162-
▌ My supernatural power and marvelous activity:
163-
▌ Drawing water and chopping wood.
164-
165-
You examine the path beneath your feet...
166-
167-
[AboutAssertions]: [■■■■■■――――――――――――――――――――] 1/4
168-
169-
170-
[Total]: [――――――――――――――――――――――――――――――――――――――――――――――――――――] 1/635
171-
172-
Run 'Show-Karma -Meditate' to begin your meditations.
173-
```
113+
![Show-Karma result screen after completing a single koan, showing one completed koan][show-karma-2]
174114

175115
You are on your own from here, but the progression should be fairly smooth.
176116
If you need help, you can always ask around in the PowerShell communities:
177117

178-
- [Slack](https://j.mp/psslack)
179-
- [Discord](https://j.mp/psdiscord)
180-
- [Reddit](https://www.reddit.com/r/PowerShell/)
181-
- [Twitter](https://twitter.com/hashtag/powershell)
182-
- [PowerShell.org Forums](https://powershell.org/forums/forum/windows-powershell-qa/)
118+
- [Slack][ps-slack]
119+
- [Discord][ps-discord]
120+
- [Reddit][ps-reddit]
121+
- [Twitter][ps-twitter]
122+
- [PowerShell.org Forums][ps-forum]
183123

184124
Good luck!
185125

@@ -235,7 +175,7 @@ Get-PSKoanLocation | Remove-Item -Recurse
235175

236176
## Contributing
237177

238-
If you would like to contribute to PSKoans, please check out the [Contributing](https://github.com/vexx32/PSKoans/blob/master/CONTRIBUTING.md) document.
178+
If you would like to contribute to PSKoans, please check out the [Contributing][contributing] document.
239179

240180
## Support the Project
241181

@@ -245,9 +185,26 @@ If you would like to support the project, you can:
245185
- [Become a Patreon Patron][patreon]
246186
- [Donate with Ko-fi][ko-fi]
247187

188+
[blog]: https://vexx32.github.io
248189
[build-badge]: https://dev.azure.com/SallowCode/PSKoans/_apis/build/status/PSKoans%20CI
249190
[build-link]: https://dev.azure.com/SallowCode/PSKoans/_build/latest?definitionId=1
191+
[contributing]: CONTRIBUTING.md
250192
[coverage-badge]: https://img.shields.io/azure-devops/coverage/SallowCode/PSKoans/1
193+
[define-koan]: https://en.wikipedia.org/wiki/K%C5%8Dan
194+
[fsharp-koans]: https://github.com/ChrisMarinos/FSharpKoans
251195
[github-sponsor]: https://github.com/sponsors/vexx32
252-
[patreon]: https://patreon.com/PSKoans
253196
[ko-fi]: https://ko-fi.com/joelsallow
197+
[logo-64]: images/logo-64px.png
198+
[logo-128]: images/logo-128px.png
199+
[logo-full]: images/logo.png
200+
[logo-svg]: images/logo.svg
201+
[patreon]: https://patreon.com/PSKoans
202+
[ps-discord]: https://j.mp/psdiscord
203+
[ps-forum]: https://powershell.org/forums/forum/windows-powershell-qa/
204+
[ps-reddit]: https://www.reddit.com/r/PowerShell/
205+
[ps-slack]: https://j.mp/psslack
206+
[ps-twitter]: https://twitter.com/hashtag/powershell
207+
[reference-docs]: docs/PSKoans.md
208+
[show-karma-1]: images/Show-Karma_1.png
209+
[show-karma-2]: images/Show-Karma_2.png
210+
[twitter]: https://twitter.com/vexx32

images/Show-Karma_1.png

1.05 MB
Loading

images/Show-Karma_2.png

1.05 MB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)