Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

New README

Since we're merging Hiro 2 to master we need a new README that
reflects coding style changes and so on.

I've also renamed file to plain README because Markdown doesn't
seem to understand new lines and long lines are not very readable
in plain text.
  • Loading branch information...
commit 3f3c4981dfd03d5e8d28d6738b983b565bbad692 1 parent 7184f3d
Anton Kovalyov valueof authored

Showing 2 changed files with 41 additions and 12 deletions. Show diff stats Hide diff stats

  1. +41 0 README
  2. +0 12 README.md
41 README
... ... @@ -0,0 +1,41 @@
  1 +Hiro
  2 +====
  3 +
  4 +Hiro is a framework for testing third-party JavaScript applications.
  5 +It runs each test suite in a separate sandbox preventing global state
  6 +leaks and conflicts.
  7 +
  8 +Stable version can be found here: http://hirojs.com/. The current
  9 +*master* branch contains the source of Hiro 2, backwards incompatible
  10 +iteration of Hiro that is scheduled to be released soon.
  11 +
  12 +Patches
  13 +-------
  14 +
  15 +Before submitting a patch please make sure that:
  16 +
  17 + 0) You have an issue opened describing your problem or proposal.
  18 + 1) You use tabs for indentation.
  19 + 2) Your coding style looks similar to what is already in the repo.
  20 + 3) All JavaScript files pass JSHint check (you can run 'grunt lint'
  21 + to automatically lint files.
  22 + 4) All tests pass. To run tests open 'tests/test.html' in your
  23 + browser.
  24 + 5) Example tests behave as intended. To check that execute 'grunt run'
  25 + and open http://localhost:7777/ in your browser. Execute all tests
  26 + and you should see only three failures:
  27 +
  28 + * BasicTests.testFailedTest
  29 + * Basictests.testFailedExpect
  30 + * FailedSuite.testSimple
  31 +
  32 + These failures were introduced for UI demonstration purposes.
  33 + 6) Your commit messages look good (no one-liners please). See most
  34 + recent commit messages for reference.
  35 +
  36 +Author
  37 +------
  38 +
  39 +Anton Kovalyov
  40 +http://anton.kovalyov.net
  41 +@valueof
12 README.md
Source Rendered
... ... @@ -1,12 +0,0 @@
1   -Hiro
2   -=======
3   -
4   -Hiro is a small yet powerful unit testing framework for JavaScript. It runs each test suite in a separate iframe sandbox, preventing global state leaks and conflicts.
5   -
6   -[More information and docs.](http://hirojs.com/)
7   -
8   -Hiro testing itself:
9   -
10   -![Hiro screenshot](http://hirojs.com/hiro-screenshot.png)
11   -
12   -

0 comments on commit 3f3c498

Please sign in to comment.
Something went wrong with that request. Please try again.