Skip to content

Added spaces in headers to take advantage of GFM #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added spaces in headers to take advantage of GFM #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#CppKoans
# CppKoans

Inspired by [RubyKoans](https://github.com/edgecase/ruby_koans) and
Inspired by [RubyKoans](https://github.com/edgecase/ruby_koans) and
[JavaScript-Koans](https://github.com/liammclennan/JavaScript-Koans), this is
an attempt to write such koans for C/C++.

Some ideas were taken from [PointerKoans](https://github.com/paytonrules/PointerKoan).

###Prerequesites
### Prerequesites
You will need [CMake](http://cmake.org/).

And of course a C++ compiler.
I just tested it with a recent GCC.

##How to walk the path to enlightment
## How to walk the path to enlightment
1. Get the sources

git clone git://github.com/torbjoernk/CppKoans.git
Expand Down Expand Up @@ -50,16 +50,16 @@ Thus, walking the path to enlightment is a repetition of these steps:
3. Read the master's reply with `./CppKoans/build/CppKoans`


##Adding further Koans
###To existing episodes
## Adding further Koans
### To existing episodes
Just define a new `private void` function without parameters in the bottom
section of the episode's header file it should belong to.
Then go to the implementation file of that episode and implement your new koan.
Finally add your newly created koan to the `run()` function in the header file
of that episode and increase the `num_tests` counter by one (or whatevery amount
of koans you added).

###New episodes
### New episodes
There is a sample episode, which can be used as a template for new episodes.
After copying and renaming of `~/headers/koanXX_sample_koans.hpp` and
`~/koans/koanXX_sample_koans.cpp` the following steps are necessary:
Expand All @@ -72,4 +72,4 @@ After copying and renaming of `~/headers/koanXX_sample_koans.hpp` and


##Licence
MIT License Copyright 2012 Torbjörn Klatt - opensource eht torbjoern minus klatt dot de
MIT License Copyright 2012 Torbjörn Klatt - opensource eht torbjoern minus klatt dot de