diff --git a/config/exercise_readme.go.tmpl b/config/exercise_readme.go.tmpl deleted file mode 100644 index d43b3b1ea..000000000 --- a/config/exercise_readme.go.tmpl +++ /dev/null @@ -1,44 +0,0 @@ -# {{ .Spec.Name }} - -{{ .Spec.Description -}} -{{- with .Hints }} -{{ . }} -{{ end }} -## Getting Started - -Make sure you have read the [Installing](https://exercism.io/tracks/cpp/installation) and -[Running the Tests](https://exercism.io/tracks/cpp/tests) pages for C++ on exercism.io. -This covers the basic information on setting up the development -environment expected by the exercises. - -## Passing the Tests - -Get the first test compiling, linking and passing by following the [three -rules of test-driven development](http://butunclebob.com/ArticleS.UncleBob.TheThreeRulesOfTdd). -Create just enough structure by declaring namespaces, functions, classes, -etc., to satisfy any compiler errors and get the test to fail. Then write -just enough code to get the test to pass. Once you've done that, -uncomment the next test by moving the following line past the next test. - -```C++ -#if defined(EXERCISM_RUN_ALL_TESTS) -``` - -This may result in compile errors as new constructs may be invoked that -you haven't yet declared or defined. Again, fix the compile errors minimally -to get a failing test, then change the code minimally to pass the test, -refactor your implementation for readability and expressiveness and then -go on to the next test. - -Try to use standard C++11 facilities in preference to writing your own -low-level algorithms or facilities by hand. [CppReference](http://en.cppreference.com/) -is a wiki reference to the C++ language and standard library. If you -are new to C++, but have programmed in C, beware of -[C traps and pitfalls](http://www.slideshare.net/LegalizeAdulthood/c-traps-and-pitfalls-for-c-programmers). -{{ with .Spec.Credits }} -## Source - -{{ . }} -{{ end }} -## Submitting Incomplete Solutions -It's possible to submit an incomplete solution so you can see how others have completed the exercise. diff --git a/exercises/shared/.docs/help.md b/exercises/shared/.docs/help.md new file mode 100644 index 000000000..b4565a370 --- /dev/null +++ b/exercises/shared/.docs/help.md @@ -0,0 +1,8 @@ +# Help + +To get help if you're having trouble, you can use one of the following resources: + +- [`c++-faq` tag on StackOverflow](https://stackoverflow.com/tags/c%2b%2b-faq/info) +- [C++ FAQ from isocpp.com](https://isocpp.org/faq) +- [CppReference](http://en.cppreference.com/) is a wiki reference to the C++ language and standard library +- [C traps and pitfalls](http://www.slideshare.net/LegalizeAdulthood/c-traps-and-pitfalls-for-c-programmers) is useful if you are new to C++, but have programmed in C diff --git a/exercises/shared/.docs/tests.md b/exercises/shared/.docs/tests.md new file mode 100644 index 000000000..da8b484ad --- /dev/null +++ b/exercises/shared/.docs/tests.md @@ -0,0 +1,26 @@ +# Tests + +Running the tests involves running `cmake -G` and then using the build command appropriate for your platform. +Detailed instructions on how to do this can be found on the [Running the Tests](https://exercism.io/tracks/cpp/tests) page for C++ on exercism.io. + +## Passing the Tests + +Get the first test compiling, linking and passing by following the [three +rules of test-driven development](http://butunclebob.com/ArticleS.UncleBob.TheThreeRulesOfTdd). +Create just enough structure by declaring namespaces, functions, classes, +etc., to satisfy any compiler errors and get the test to fail. Then write +just enough code to get the test to pass. Once you've done that, +uncomment the next test by moving the following line past the next test. + +```C++ +#if defined(EXERCISM_RUN_ALL_TESTS) +``` + +This may result in compile errors as new constructs may be invoked that +you haven't yet declared or defined. Again, fix the compile errors minimally +to get a failing test, then change the code minimally to pass the test, +refactor your implementation for readability and expressiveness and then +go on to the next test. + +Try to use standard C++11 facilities in preference to writing your own +low-level algorithms or facilities by hand.