Skip to content
This repository was archived by the owner on May 28, 2019. It is now read-only.

README tweaks #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README tweaks #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94fa235
README tweaks
Zearin Jun 15, 2016
5792b36
Update README.md
Zearin Feb 13, 2018
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Microcuke

[![Join the chat at https://gitter.im/cucumber/gherkin3](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/microcuke?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/cucumber/microcuke.svg)](https://travis-ci.org/cucumber/microcuke)
[![Join the chat at https://gitter.im/cucumber-attic/microcuke](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/microcuke?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/cucumber-attic/microcuke.svg)](https://travis-ci.org/cucumber/microcuke)

Microcuke is a tiny Cucumber implementation in 500 SLOC, based on
[Gherkin3](https://github.com/cucumber/gherkin3). It's got 100% unit test coverage.
Microcuke is a tiny Cucumber implementation in 500 <abbr title="Source Lines Of Code">SLOC</abbr>,
based on [Gherkin](https://github.com/cucumber/gherkin). It has 100% unit test coverage.

The sole purpose of microcuke is to provide a very simple reference implementation that
The sole purpose of Microcuke is to provide a super simple reference implementation that
can be ported to a new programming language in a few days. Think of it as an aid to
developers who wish to implement Cucumber for a new programming language.

Expand All @@ -16,13 +16,13 @@ we aim to write self-explanatory, simple code instead. If you find something
hard to understand, that's a bug! Feel free to open a bug report.

Most of Microcuke is written in synchronous JavaScript (for readability), but there are
some parts that are asynchronous (using promises and callbacks). These constructs are
some parts that are asynchronous (promises and callbacks). These constructs are
fairly JavaScript-specific, so if you are using microcuke as a guid to write a Cucumber
implementation for a new language, you should probably translate that code to simple synchronous code.

Here is a high level class diagram to give you an idea:

![](https://github.com/cucumber/microcuke/blob/master/docs/classes.png)
![](https://github.com/cucumber-attic/microcuke/blob/master/docs/classes.png)

## Try it out

Expand Down