Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

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 f150fb90883760da9797e04e2c05a4d1fd46c063 1 parent 7184f3d
@valueof authored
Showing with 41 additions and 12 deletions.
  1. +41 −0 README
  2. +0 −12 README.md
View
41 README
@@ -0,0 +1,41 @@
+Hiro
+====
+
+Hiro is a framework for testing third-party JavaScript applications.
+It runs each test suite in a separate sandbox preventing global state
+leaks and conflicts.
+
+Stable version can be found here: http://hirojs.com/. The current
+*master* branch contains the source of Hiro 2, backwards incompatible
+iteration of Hiro that is scheduled to be released soon.
+
+Patches
+-------
+
+Before submitting a patch please make sure that:
+
+ 0) You have an issue opened describing your problem or proposal.
+ 1) You use tabs for indentation.
+ 2) Your coding style looks similar to what is already in the repo.
+ 3) All JavaScript files pass JSHint check (you can run 'grunt lint'
+ to automatically lint files.
+ 4) All tests pass. To run tests open 'tests/test.html' in your
+ browser.
+ 5) Example tests behave as intended. To check that execute 'grunt run'
+ and open http://localhost:7777/ in your browser. Execute all tests
+ and you should see only three failures:
+
+ * BasicTests.testFailedTest
+ * Basictests.testFailedExpect
+ * FailedSuite.testSimple
+
+ These failures were introduced for UI demonstration purposes.
+ 6) Your commit messages look good (no one-liners please). See most
+ recent commit messages for reference.
+
+Author
+------
+
+Anton Kovalyov
+http://anton.kovalyov.net
+@valueof
View
12 README.md
@@ -1,12 +0,0 @@
-Hiro
-=======
-
-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.
-
-[More information and docs.](http://hirojs.com/)
-
-Hiro testing itself:
-
-![Hiro screenshot](http://hirojs.com/hiro-screenshot.png)
-
-
Please sign in to comment.
Something went wrong with that request. Please try again.