Skip to content

Commit

Permalink
chore: update readme page
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianth committed Sep 10, 2018
1 parent a9ec285 commit 03ec05b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
4 changes: 4 additions & 0 deletions .github/CONTRIBUTING.md
Expand Up @@ -51,3 +51,7 @@ to read on GitHub as well as in various git tools.
## Code Quality

Please strive to produce clean, good quality code. We are not being nitpicky, but things like descriptive names, proper indentation/code layout, good comments, style consistency, etc. are important and neglecting these aspects causes the code quality to deteriorate over time, ultimately affecting all of us that maintain or use the product. When in doubt, please consult the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for Java code and the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript.

## License

Unless you explicitly state otherwise, any contribution intentionally submitted by you for inclusion in this repository shall be licensed as above, without any additional terms or conditions.
25 changes: 7 additions & 18 deletions README.adoc
Expand Up @@ -27,27 +27,14 @@ OpenTest aims to offer all the features of a modern test automation tool while f
(and we had to skip a lot of really cool features to keep this brief)

== Installation
Prerequisites: https://nodejs.org/en/[Node.js 6] or greater; https://java.com/en/download/[Java runtime 8] or greater.

Video tutorial: https://youtu.be/7aJGnHGNlHs (recorded on Windows)
Prerequisites: https://nodejs.org/en/[Node.js 8] or greater; https://java.com/en/download/[Java runtime 8] or greater.

Install from npm:
```
npm install opentest -g
```

[NOTE]
====
Depending on how npm is configured on your machine, you might need to run with sudo on macOS/Linux or as Administrator on Windows.
On Windows, because of a long-standing npm bug, you might get an error at the end of the install process that is related to the `fsevents` module. It's probably safe to ignore it. See more details https://github.com/npm/npm/issues/17671[here].
====

Alternatively, install using yarn:
```
npm install yarn -g
yarn global add opentest
```
Video tutorial: https://getopentest.org/docs/installation.html (recorded on Windows)

== Quick start

Expand Down Expand Up @@ -129,9 +116,11 @@ image::https://user-images.githubusercontent.com/5209882/34263230-63d8e87c-e634-

NOTE: We are currently documenting the various features at https://getopentest.org, but if you feel the documentation is lacking a bit, you are probably right and we are hard at work fixing this as we speak. In the meantime, please post any questions you have as https://github.com/mcdcorp/opentest/issues/new[GitHub issues] or https://stackoverflow.com/questions/ask[Stack Overflow] questions (make sure to have `OpenTest` in the question title).

== License
OpenTest is open source software released under the http://www.opensource.org/licenses/mit-license[MIT license].

== Contributing

Please see the https://github.com/mcdcorp/opentest/blob/master/.github/CONTRIBUTING.md[contributing guidelines].
Unless you explicitly state otherwise, any contribution intentionally submitted by you for inclusion in this repository shall be licensed as above, without any additional terms or conditions.

== License
OpenTest is open source software released under the http://www.opensource.org/licenses/mit-license[MIT license].
For more information please see the https://github.com/mcdcorp/opentest/blob/master/.github/CONTRIBUTING.md[contributing guidelines] document.

0 comments on commit 03ec05b

Please sign in to comment.