Skip to content
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.

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

Refactor README #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,40 @@
# Kata: Sing a song (refactoring)

You can find a [Node.js](https://nodejs.org/en/) and JavaScript ES6 implementation of the kata in the [javascript](javascript) folder; produce the song with:
https://github.com/sleepyfox/code-dojo-39

node song.js

Similarly a [Ruby](https://www.ruby-lang.org/en/) version can be found in the [ruby](ruby) folder; produce the song with:
## Objective

ruby song.rb
Here, you will find the code to produce a popular children's nursary rhyme, produced by a web agency for the customer last year.

A [Python](https://www.python.org/) version can be found in the [python](python) folder; produce the song with:
The customer now desires to produce multiple different versions of the song using the same structure but based on different themes, for example a current popular children's movie featuring a cast of animals.

python song.py
The customer asks that you make the song configurable for different lists of animals. They cannot guarantee that there will be the same number of animals in each different version.

A [Java](https://www.java.com/) version can be found in the [java](java) folder; produce the song with:
Refactor the code to allow for the customer's needs.

javac Song.java && java Song

A [PHP](https://php.net/) version can be found in the [PHP](PHP) folder; produce the song with:
No documentation or tests were provided by the previous developer.

php song.php
_Remember: refactoring can only be done in the presence of tests that are passing, and after refactoring the tests still pass!_

A .NET Core version implementation of the kata in the `csharp\dotnetcore` folder; produce the song with:
# Provided Languages

```bash
cd song
dotnet run
```
You will find versions of the code in the following languages:

A [Go](https://golang.org/) version can be found in the [golang](golang) folder; produce the song with:
* C++
* C#
* Elixir
* Go (aka Golang)
* Java
* Javascript
* PHP
* Python
* Ruby

go run main.go
In case you don't see your favourite programming language here, please feel free to open a PR to add it.

## About

You can find out more about the London Code Dojo at our [homepage](http://www.meetup.com/London-Code-Dojo/).

## Objective

Code to produce a popular children's nursary rhyme was produced by a web agency for the customer last year. The customer now desires to produce multiple different versions of the song using the same structure but based on different themes, for example a current popular children's movie featuring a cast of animals. The customer asks that you make the song configurable for different lists of animals. The customer cannot guarentee that there will be the same number of animals in each different version.

No documentation or tests were provided by the previous developer.

Refactor the code to allow for the customer's needs.
_Remember: refactoring can only be done in the presence of tests that are passing, and after refactoring the tests still pass!_

# License
## License
The code samples are licensed under the CC-SA-NC-4.0 license, as shown in the [LICENSE](/LICENSE) file.
8 changes: 8 additions & 0 deletions csharp/dotnetcore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Sing a Song - .NET Core version

Produce the song with:

```bash
cd song
dotnet run
```
8 changes: 0 additions & 8 deletions csharp/dotnetcore/readme.md

This file was deleted.

5 changes: 5 additions & 0 deletions golang/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - Go (aka Golang) version

Produce the song with:

go run main.gcast
5 changes: 5 additions & 0 deletions java/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - Java version

Produce the song with:

javac Song.java && java Song
5 changes: 5 additions & 0 deletions javascript/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - Javascript version

Produce the song with:

node song.js
5 changes: 5 additions & 0 deletions php/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - PHP version

Produce the song with:

php song.php
File renamed without changes.
5 changes: 5 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - Python version

Produce the song with:

python song.py
5 changes: 5 additions & 0 deletions ruby/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Sing a Song - Ruby version

Produce the song with:

ruby song.rb