Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emilybache committed Nov 30, 2023
1 parent 66947ab commit 91194a2
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 1 deletion.
10 changes: 10 additions & 0 deletions cpp/Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Tennis-Refactoring-Kata C++ with Google test

For main description, see [top level README](../README.md).

If working with an IDE with google test
support, such as CLion, the google-test gives a better overview
of issues. Downside is that google-test has to be obtained (by
Expand Down Expand Up @@ -83,3 +85,11 @@ cmake .. -G "Unix Makefiles"
cmake --build .
ctest
```

## Code Reading Practice
Here is a list of github urls of all the TennisGame C++ classes:

* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/cpp/tennis1.cc
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/cpp/tennis2.cc
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/cpp/tennis3.cc
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/cpp/tennis4.cc
10 changes: 10 additions & 0 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,13 @@ It uses Java 17 and the [Maven Wrapper](https://maven.apache.org/wrapper/) to bu
`./mvnw clean verify`

Prerequisites: a Java 17 Development Kit must be installed.

## Code Reading Practice
Here is a list of github urls of all the TennisGame Java classes:

* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame1.java
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame2.java
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame3.java
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame4.java
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame5.java
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/java/src/main/java/TennisGame6.java
18 changes: 18 additions & 0 deletions javascript-jest/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Tennis in JavaScript with Jest

For main description, see [top level README](../README.md).

To run the tests:

npm test


## Code Reading Practice
Here is a list of github urls of all the TennisGame Javascript modules:

* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis1.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis2.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis3.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis4.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis5.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis6.js
14 changes: 13 additions & 1 deletion javascript/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# Tennis in JavaScript

For main description, see [top level README](../README.md).

Tests are available to be run both with node.js and in the browser.
For node, simply call
node TennisTest.js
(Only failures will be shown on the console)

For the browser, open TennisTest.html and refresh after change.
For the browser, open TennisTest.html and refresh after change.

## Code Reading Practice
Here is a list of github urls of all the TennisGame Javascript modules:

* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis1.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis2.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis3.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis4.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis5.js
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/javascript-jest/tennis6.js
13 changes: 13 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Tennis Refactoring Kata in Python

For main description, see [top level README](../README.md).

## Code Reading Practice
Here is a list of github urls of all the TennisGame Python modules:

* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis1.py
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis2.py
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis3.py
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis4.py
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis5.py
* https://github.com/emilybache/Tennis-Refactoring-Kata/blob/main/python/tennis6.py

0 comments on commit 91194a2

Please sign in to comment.