Skip to content

Commit

Permalink
Update documentation (#615)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikSchierboom authored and John Reese committed Aug 7, 2018
1 parent a645ca3 commit ae18b13
Show file tree
Hide file tree
Showing 123 changed files with 1,105 additions and 103 deletions.
8 changes: 8 additions & 0 deletions config/exercise_readme.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
{{- with .Hints }}
{{ . }}
{{ end }}
## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).
{{ with .Spec.Credits }}
## Source

Expand Down
29 changes: 17 additions & 12 deletions docs/RESOURCES.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
## Recommended Learning Resources

### Blogs
* The official [.NET blog](https://blogs.msdn.microsoft.com/dotnet/) has lots of interesting C# articles, ranging from beginner to expert difficulty.
* 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.
* Eric Lippert's [Fabulous adventures in coding](https://ericlippert.com/) is a brilliant C# blog, although his subjects are usually quite advanced.
* 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.

- The official [.NET blog](https://blogs.msdn.microsoft.com/dotnet/) has lots of interesting C# articles, ranging from beginner to expert difficulty.
- 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.
- Eric Lippert's [Fabulous adventures in coding](https://ericlippert.com/) is a brilliant C# blog, although his subjects are usually quite advanced.
- 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.

### Social media
* [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.
* [/r/csharp](https://www.reddit.com/r/csharp) is the C# subreddit.
* [\@dotnet](https://twitter.com/DotNet) is the official .NET Twitter account.
* [Gitter](https://gitter.im/exercism/xcsharp) is the C# Gitter room, go here to get support and ask questions related to the C# track.

- [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.
- [/r/csharp](https://www.reddit.com/r/csharp) is the C# subreddit.
- [@dotnet](https://twitter.com/DotNet) is the official .NET Twitter account.
- [Gitter](https://gitter.im/exercism/xcsharp) is the C# Gitter room, go here to get support and ask questions related to the C# track.

### Videos
* 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.
* 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).

- 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.
- 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).

### Podcasts
* [.NET Rocks](https://www.dotnetrocks.com/) is a very nice .NET podcast with great content.

- [.NET Rocks](https://www.dotnetrocks.com/) is a very nice .NET podcast with great content.

### Books
* [Expert C# 5.0](http://www.apress.com/us/book/9781430248606)

- [Expert C# 5.0](http://www.apress.com/us/book/9781430248606)
4 changes: 2 additions & 2 deletions docs/TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ To help you get started, each exercise comes with a stub implementation file. Yo
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:

```bash
dotnet add package <package-name>
```
dotnet add package [package-name]
```
8 changes: 8 additions & 0 deletions exercises/accumulate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ Solve this one yourself using other basic tools instead.
## Hints
This exercise requires you to write an extension method. For more information, see [this page](https://msdn.microsoft.com/en-us//library/bb383977.aspx).

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/acronym/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Techies love their TLA (Three Letter Acronyms)!
Help generate some jargon by writing a program that converts a long name
like Portable Network Graphics to its acronym (PNG).

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/all-your-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ I think you got the idea!

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

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
8 changes: 8 additions & 0 deletions exercises/allergies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ score is 257, your program should only report the eggs (1) allergy.
## Hints
This exercise requires you to use bitwise operations. For more information, see [this page](https://msdn.microsoft.com/en-us/library/6a71f45d.aspx).

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/alphametics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ Try to find a more sophisticated solution.
- Hint: You could try the column-wise addition algorithm that is usually taught in school.


## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
8 changes: 8 additions & 0 deletions exercises/anagram/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ Given `"listen"` and a list of candidates like `"enlists" "google"
"inlets" "banana"` the program should return a list containing
`"inlets"`.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
10 changes: 9 additions & 1 deletion exercises/armstrong-numbers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,20 @@ An [Armstrong number](https://en.wikipedia.org/wiki/Narcissistic_number) is a nu
For example:

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

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

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/atbash-cipher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ things based on word boundaries.
- Decoding `gvhg` gives `test`
- Decoding `gsvjf rxpyi ldmul cqfnk hlevi gsvoz abwlt` gives `thequickbrownfoxjumpsoverthelazydog`

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/bank-account/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ This exercise requires you to handle data related to currency and money. A norma
Note though that you then only store the numeric value of a currency.


## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
8 changes: 8 additions & 0 deletions exercises/beer-song/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,14 @@ experiment make the code better? Worse? Did you learn anything from it?
## Hints
- Try to capture the structure of the song in your code, where you build up the song by composing its parts.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/binary-search-tree/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ And if we then added 1, 5, and 7, it would look like this
/ \ / \
1 3 5 7

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/binary-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ A binary search halves the number of items to check with each iteration,
so locating an item (or determining its absence) takes logarithmic time.
A binary search is a dichotomic divide and conquer search algorithm.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/binary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ Binary is similar, but uses powers of 2 rather than powers of 10.

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

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
10 changes: 10 additions & 0 deletions exercises/bob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ anything.

He answers 'Whatever.' to anything else.

Bob's conversational partner is a purist when it comes to written communication and always follows normal rules regarding sentence punctuation in English.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/book-store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ For a total of $51.20

And $51.20 is the price with the biggest discount.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/bowling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ support two operations:
* `score() : int` is called only at the very end of the game. It
returns the total score for that game.

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
13 changes: 11 additions & 2 deletions exercises/bracket-push/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Bracket Push

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

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/change/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ that the sum of the coins' value would equal the correct amount of change.
- Can you ask for negative change?
- Can you ask for a change value smaller than the smallest coin value?

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
8 changes: 8 additions & 0 deletions exercises/circular-buffer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ the buffer is once again full.

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

## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
4 changes: 2 additions & 2 deletions exercises/clock/.meta/hints.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Hints
This exercise requires you to implements a type-specific method for determining equality of instances.
This exercise requires you to implement a type-specific method for determining equality of instances.
For more information, see [this page]
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1) .
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1).
2 changes: 1 addition & 1 deletion exercises/clock/Clock.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using System;

public struct Clock
public class Clock
{
public Clock(int hours, int minutes)
{
Expand Down
14 changes: 14 additions & 0 deletions exercises/clock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@ You should be able to add and subtract minutes to it.

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

## Hints
This exercise requires you to implement a type-specific method for determining equality of instances.
For more information, see [this page]
(https://docs.microsoft.com/en-us/dotnet/core/api/System.IEquatable-1) .


## Running the tests

To run the tests, run the command `dotnet test` from within the exercise directory.

## Further information

For more detailed information about the C# track, including how to get help if
you're having trouble, please visit the exercism.io [C# language page](http://exercism.io/languages/csharp/resources).

## Source

Expand Down
Loading

0 comments on commit ae18b13

Please sign in to comment.