Skip to content

Minimal doc about running tests for the gem #83

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.

Sign up for GitHub

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

Closed
olance wants to merge 1 commit into from
Closed

Minimal doc about running tests for the gem #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,11 @@ If you replace `JSXTransformer.js` in production environment, you have to restar
because the jsx compiler context is cached.

Name of the `JSXTransformer.js` file *is case-sensitive*.

# Testing

A global installation of Phantomjs is required to run the tests:
Copy link
Member

@zpao zpao Sep 7, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: PhantomJS, and probably worth making that a link.

npm install -g phantomjs
Copy link
Member

@zpao zpao Sep 7, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should mention alternative installation methods, namely brew install phantomjs (I hear Ruby people get upset about JS package managers)
Copy link
Contributor

@vipulnsward vipulnsward Oct 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, many don't happen to use npm.
Copy link
Contributor Author

@olance olance Oct 12, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, I wasn't even aware there was a Formula on Homebrew for PhantomJS :)
(and I'm a rubyist ^^)

Run `rake` to launch the test suites.
Copy link
Contributor

@vipulnsward vipulnsward Oct 4, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olance perhaps an example test, would be nice to have.
Copy link
Member

@zpao zpao Oct 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What example test? The point is to run the tests of this gem...
Copy link
Contributor Author

@olance olance Oct 14, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, that was my feeling too ^^