Skip to content

Commit ae18b13

Browse files
ErikSchierboomJohn Reese
authored and
John Reese
committed
Update documentation (#615)
1 parent a645ca3 commit ae18b13

File tree

123 files changed

+1105
-103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+1105
-103
lines changed

config/exercise_readme.go.tmpl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
{{- with .Hints }}
55
{{ . }}
66
{{ end }}
7+
## Running the tests
8+
9+
To run the tests, run the command `dotnet test` from within the exercise directory.
10+
11+
## Further information
12+
13+
For more detailed information about the C# track, including how to get help if
14+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
715
{{ with .Spec.Credits }}
816
## Source
917

docs/RESOURCES.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
## Recommended Learning Resources
22

33
### Blogs
4-
* The official [.NET blog](https://blogs.msdn.microsoft.com/dotnet/) has lots of interesting C# articles, ranging from beginner to expert difficulty.
5-
* Scott Hanselman's [blog](http://www.hanselman.com/blog/) is an active, well written blog on a wide variety of C# and .NET related subjects.
6-
* Eric Lippert's [Fabulous adventures in coding](https://ericlippert.com/) is a brilliant C# blog, although his subjects are usually quite advanced.
7-
* The [C#/.NET Little Wonders & Little Pitfalls](http://geekswithblogs.net/BlackRabbitCoder/archive/2015/04/02/c.net-little-wonders-amp-little-pitfalls-the-complete-collection.aspx) posts by James Michael Hare contains some fantastic posts on less known C# features.
4+
5+
- The official [.NET blog](https://blogs.msdn.microsoft.com/dotnet/) has lots of interesting C# articles, ranging from beginner to expert difficulty.
6+
- Scott Hanselman's [blog](http://www.hanselman.com/blog/) is an active, well written blog on a wide variety of C# and .NET related subjects.
7+
- Eric Lippert's [Fabulous adventures in coding](https://ericlippert.com/) is a brilliant C# blog, although his subjects are usually quite advanced.
8+
- The [C#/.NET Little Wonders & Little Pitfalls](http://geekswithblogs.net/BlackRabbitCoder/archive/2015/04/02/c.net-little-wonders-amp-little-pitfalls-the-complete-collection.aspx) posts by James Michael Hare contains some fantastic posts on less known C# features.
89

910
### Social media
10-
* [StackOverflow ](http://stackoverflow.com/questions/tagged/c%23) can be used to search for your problem and see if it has been answered already. You can also ask and answer questions.
11-
* [/r/csharp](https://www.reddit.com/r/csharp) is the C# subreddit.
12-
* [\@dotnet](https://twitter.com/DotNet) is the official .NET Twitter account.
13-
* [Gitter](https://gitter.im/exercism/xcsharp) is the C# Gitter room, go here to get support and ask questions related to the C# track.
11+
12+
- [StackOverflow](http://stackoverflow.com/questions/tagged/c%23) can be used to search for your problem and see if it has been answered already. You can also ask and answer questions.
13+
- [/r/csharp](https://www.reddit.com/r/csharp) is the C# subreddit.
14+
- [@dotnet](https://twitter.com/DotNet) is the official .NET Twitter account.
15+
- [Gitter](https://gitter.im/exercism/xcsharp) is the C# Gitter room, go here to get support and ask questions related to the C# track.
1416

1517
### Videos
16-
* In [On .NET](https://www.youtube.com/watch?v=GpLU0UdcGic&list=PL4Sf58qFxdyQuzB1mH5kln_otKpsIuoCO), Bertrand Le Roy interviews people on a wide variety of C#/.NET related subjects.
17-
* There are several great [C# courses](https://www.pluralsight.com/search?q=*&categories=course&roles=software-development%7C&subjects=c%23) on PluralSight. The downside: PluralSight is a paid service, but you can request a [free trial](https://www.pluralsight.com/pricing).
18+
19+
- In [On .NET](https://www.youtube.com/watch?v=GpLU0UdcGic&list=PL4Sf58qFxdyQuzB1mH5kln_otKpsIuoCO), Bertrand Le Roy interviews people on a wide variety of C#/.NET related subjects.
20+
- There are several great [C# courses](https://www.pluralsight.com/search?q=*&categories=course&roles=software-development%7C&subjects=c%23) on PluralSight. The downside: PluralSight is a paid service, but you can request a [free trial](https://www.pluralsight.com/pricing).
1821

1922
### Podcasts
20-
* [.NET Rocks](https://www.dotnetrocks.com/) is a very nice .NET podcast with great content.
23+
24+
- [.NET Rocks](https://www.dotnetrocks.com/) is a very nice .NET podcast with great content.
2125

2226
### Books
23-
* [Expert C# 5.0](http://www.apress.com/us/book/9781430248606)
27+
28+
- [Expert C# 5.0](http://www.apress.com/us/book/9781430248606)

docs/TESTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ To help you get started, each exercise comes with a stub implementation file. Yo
1717
You should be able to solve most exercises without using any external packages. However, for the exercises where you do want to use an external package, you can add it to your project by running the following command:
1818

1919
```bash
20-
dotnet add package <package-name>
21-
```
20+
dotnet add package [package-name]
21+
```

exercises/accumulate/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ Solve this one yourself using other basic tools instead.
2828
## Hints
2929
This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).
3030

31+
## Running the tests
32+
33+
To run the tests, run the command `dotnet test` from within the exercise directory.
34+
35+
## Further information
36+
37+
For more detailed information about the C# track, including how to get help if
38+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3139

3240
## Source
3341

exercises/acronym/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Techies love their TLA (Three Letter Acronyms)!
77
Help generate some jargon by writing a program that converts a long name
88
like Portable Network Graphics to its acronym (PNG).
99

10+
## Running the tests
11+
12+
To run the tests, run the command `dotnet test` from within the exercise directory.
13+
14+
## Further information
15+
16+
For more detailed information about the C# track, including how to get help if
17+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
1018

1119
## Source
1220

exercises/all-your-base/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ I think you got the idea!
3131

3232
*Yes. Those three numbers above are exactly the same. Congratulations!*
3333

34+
## Running the tests
35+
36+
To run the tests, run the command `dotnet test` from within the exercise directory.
37+
38+
## Further information
39+
40+
For more detailed information about the C# track, including how to get help if
41+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3442

3543
## Submitting Incomplete Solutions
3644
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

exercises/allergies/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ score is 257, your program should only report the eggs (1) allergy.
3232
## Hints
3333
This exercise requires you to use bitwise operations. For more information, see [this page](https://msdn.microsoft.com/en-us/library/6a71f45d.aspx).
3434

35+
## Running the tests
36+
37+
To run the tests, run the command `dotnet test` from within the exercise directory.
38+
39+
## Further information
40+
41+
For more detailed information about the C# track, including how to get help if
42+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3543

3644
## Source
3745

exercises/alphametics/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Try to find a more sophisticated solution.
3838
- Hint: You could try the column-wise addition algorithm that is usually taught in school.
3939

4040

41+
## Running the tests
42+
43+
To run the tests, run the command `dotnet test` from within the exercise directory.
44+
45+
## Further information
46+
47+
For more detailed information about the C# track, including how to get help if
48+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
4149

4250
## Submitting Incomplete Solutions
4351
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

exercises/anagram/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ Given `"listen"` and a list of candidates like `"enlists" "google"
66
"inlets" "banana"` the program should return a list containing
77
`"inlets"`.
88

9+
## Running the tests
10+
11+
To run the tests, run the command `dotnet test` from within the exercise directory.
12+
13+
## Further information
14+
15+
For more detailed information about the C# track, including how to get help if
16+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
917

1018
## Source
1119

exercises/armstrong-numbers/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,20 @@ An [Armstrong number](https://en.wikipedia.org/wiki/Narcissistic_number) is a nu
55
For example:
66

77
- 9 is an Armstrong number, because `9 = 9^1 = 9`
8-
- 10 is *not* an Armstrong number, because `10 != 1^2 + 0^2 = 2`
8+
- 10 is *not* an Armstrong number, because `10 != 1^2 + 0^2 = 1`
99
- 153 is an Armstrong number, because: `153 = 1^3 + 5^3 + 3^3 = 1 + 125 + 27 = 153`
1010
- 154 is *not* an Armstrong number, because: `154 != 1^3 + 5^3 + 4^3 = 1 + 125 + 64 = 190`
1111

1212
Write some code to determine whether a number is an Armstrong number.
1313

14+
## Running the tests
15+
16+
To run the tests, run the command `dotnet test` from within the exercise directory.
17+
18+
## Further information
19+
20+
For more detailed information about the C# track, including how to get help if
21+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
1422

1523
## Source
1624

exercises/atbash-cipher/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ things based on word boundaries.
2828
- Decoding `gvhg` gives `test`
2929
- Decoding `gsvjf rxpyi ldmul cqfnk hlevi gsvoz abwlt` gives `thequickbrownfoxjumpsoverthelazydog`
3030

31+
## Running the tests
32+
33+
To run the tests, run the command `dotnet test` from within the exercise directory.
34+
35+
## Further information
36+
37+
For more detailed information about the C# track, including how to get help if
38+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3139

3240
## Source
3341

exercises/bank-account/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ This exercise requires you to handle data related to currency and money. A norma
3131
Note though that you then only store the numeric value of a currency.
3232

3333

34+
## Running the tests
35+
36+
To run the tests, run the command `dotnet test` from within the exercise directory.
37+
38+
## Further information
39+
40+
For more detailed information about the C# track, including how to get help if
41+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3442

3543
## Submitting Incomplete Solutions
3644
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

exercises/beer-song/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,14 @@ experiment make the code better? Worse? Did you learn anything from it?
323323
## Hints
324324
- Try to capture the structure of the song in your code, where you build up the song by composing its parts.
325325

326+
## Running the tests
327+
328+
To run the tests, run the command `dotnet test` from within the exercise directory.
329+
330+
## Further information
331+
332+
For more detailed information about the C# track, including how to get help if
333+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
326334

327335
## Source
328336

exercises/binary-search-tree/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ And if we then added 1, 5, and 7, it would look like this
5353
/ \ / \
5454
1 3 5 7
5555

56+
## Running the tests
57+
58+
To run the tests, run the command `dotnet test` from within the exercise directory.
59+
60+
## Further information
61+
62+
For more detailed information about the C# track, including how to get help if
63+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
5664

5765
## Source
5866

exercises/binary-search/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ A binary search halves the number of items to check with each iteration,
3434
so locating an item (or determining its absence) takes logarithmic time.
3535
A binary search is a dichotomic divide and conquer search algorithm.
3636

37+
## Running the tests
38+
39+
To run the tests, run the command `dotnet test` from within the exercise directory.
40+
41+
## Further information
42+
43+
For more detailed information about the C# track, including how to get help if
44+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3745

3846
## Source
3947

exercises/binary/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ Binary is similar, but uses powers of 2 rather than powers of 10.
3030

3131
So: `101 => 1*2^2 + 0*2^1 + 1*2^0 => 1*4 + 0*2 + 1*1 => 4 + 1 => 5 base 10`.
3232

33+
## Running the tests
34+
35+
To run the tests, run the command `dotnet test` from within the exercise directory.
36+
37+
## Further information
38+
39+
For more detailed information about the C# track, including how to get help if
40+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
3341

3442
## Source
3543

exercises/bob/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ anything.
1313

1414
He answers 'Whatever.' to anything else.
1515

16+
Bob's conversational partner is a purist when it comes to written communication and always follows normal rules regarding sentence punctuation in English.
17+
18+
## Running the tests
19+
20+
To run the tests, run the command `dotnet test` from within the exercise directory.
21+
22+
## Further information
23+
24+
For more detailed information about the C# track, including how to get help if
25+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
1626

1727
## Source
1828

exercises/book-store/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ For a total of $51.20
6767

6868
And $51.20 is the price with the biggest discount.
6969

70+
## Running the tests
71+
72+
To run the tests, run the command `dotnet test` from within the exercise directory.
73+
74+
## Further information
75+
76+
For more detailed information about the C# track, including how to get help if
77+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
7078

7179
## Source
7280

exercises/bowling/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ support two operations:
6060
* `score() : int` is called only at the very end of the game. It
6161
returns the total score for that game.
6262

63+
## Running the tests
64+
65+
To run the tests, run the command `dotnet test` from within the exercise directory.
66+
67+
## Further information
68+
69+
For more detailed information about the C# track, including how to get help if
70+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
6371

6472
## Source
6573

exercises/bracket-push/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# Bracket Push
22

3-
Given a string containing brackets `[]`, braces `{}` and parentheses `()`,
4-
verify that all the pairs are matched and nested correctly.
3+
Given a string containing brackets `[]`, braces `{}`, parentheses `()`,
4+
or any combination thereof, verify that any and all pairs are matched
5+
and nested correctly.
56

7+
## Running the tests
8+
9+
To run the tests, run the command `dotnet test` from within the exercise directory.
10+
11+
## Further information
12+
13+
For more detailed information about the C# track, including how to get help if
14+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
615

716
## Source
817

exercises/change/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ that the sum of the coins' value would equal the correct amount of change.
1616
- Can you ask for negative change?
1717
- Can you ask for a change value smaller than the smallest coin value?
1818

19+
## Running the tests
20+
21+
To run the tests, run the command `dotnet test` from within the exercise directory.
22+
23+
## Further information
24+
25+
For more detailed information about the C# track, including how to get help if
26+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
1927

2028
## Source
2129

exercises/circular-buffer/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ the buffer is once again full.
5050

5151
[D][7][8][9][A][B][C]
5252

53+
## Running the tests
54+
55+
To run the tests, run the command `dotnet test` from within the exercise directory.
56+
57+
## Further information
58+
59+
For more detailed information about the C# track, including how to get help if
60+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
5361

5462
## Source
5563

exercises/clock/.meta/hints.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
## Hints
2-
This exercise requires you to implements a type-specific method for determining equality of instances.
2+
This exercise requires you to implement a type-specific method for determining equality of instances.
33
For more information, see [this page]
4-
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1) .
4+
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1).

exercises/clock/Clock.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System;
22

3-
public struct Clock
3+
public class Clock
44
{
55
public Clock(int hours, int minutes)
66
{

exercises/clock/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ You should be able to add and subtract minutes to it.
66

77
Two clocks that represent the same time should be equal to each other.
88

9+
## Hints
10+
This exercise requires you to implement a type-specific method for determining equality of instances.
11+
For more information, see [this page]
12+
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1) .
13+
14+
15+
## Running the tests
16+
17+
To run the tests, run the command `dotnet test` from within the exercise directory.
18+
19+
## Further information
20+
21+
For more detailed information about the C# track, including how to get help if
22+
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
923

1024
## Source
1125

0 commit comments

Comments
 (0)