Skip to content

Commit 94406c1

Browse files
matybmatyb
committed
README formatting
1 parent 3cf11da commit 94406c1

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

README renamed to README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
Running Instructions:
2+
=====================
23
1. Download and unarchive the contents of the most recent java-koans in development from:
34
https://github.com/matyb/java-koans/archives/master
45
2. Open a terminal and cd to the koans directory within the directory you unarchived
5-
* koans: this directory contains the application and its lessons, it is all that is needed to advance through the koans themselves.
6-
* koans-lib: the directory for the koans the application
7-
* koans-tests is the directory for tests to check the sanity of the application
6+
* koans: this directory contains the application and its lessons, it is all that is needed to advance through the koans themselves.
7+
* koans-lib: the directory for the koans the application
8+
* koans-tests is the directory for tests to check the sanity of the application
89
3. Run run.bat or run.sh (whichever is applicable for your OS)
910

1011
Developing a Koan:

‎koans/README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
Running Instructions:
2+
=====================
23
1. Download and unarchive the contents of the most recent java-koans in development from:
34
https://github.com/matyb/java-koans/archives/master
4-
2. Open a terminal and cd to the 'koans' directory from within the archive (koans-lib is the source directory for the koans engine, and koans-tests is the source directory for unit tests against the koans engine - both are unnecessary for advancing through the koans)
5-
3. Run run.bat or run.sh found in the koans folder (whichever is applicable for your OS)
5+
2. Open a terminal and cd to the koans directory within the directory you unarchived
6+
* koans: this directory contains the application and its lessons, it is all that is needed to advance through the koans themselves.
7+
* koans-lib: the directory for the koans the application
8+
* koans-tests is the directory for tests to check the sanity of the application
9+
3. Run run.bat or run.sh (whichever is applicable for your OS)
610

711
Developing a Koan:
812
1. Follow any of the existing koans as an example to create a new class w/ koan methods (indicated by the @Koan annotation)

0 commit comments

Comments
 (0)