github.com/mattdotmatt/gauge@v0.3.2-0.20160421115137-425a4cdccb62/README.md (about) 1 ![Gauge Logo](Gauge-Logo.png) 2 3 # Welcome to Gauge 4 5 [![Join the chat at https://gitter.im/getgauge/gauge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/getgauge/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://snap-ci.com/getgauge/gauge/branch/master/build_image)](https://snap-ci.com/getgauge/gauge/branch/master) [ ![Download Nightly](https://api.bintray.com/packages/gauge/Gauge/Nightly/images/download.svg) ](https://bintray.com/gauge/Gauge/Nightly/_latestVersion) 6 7 Gauge is a light weight cross-platform test automation tool. It provides the ability to author test cases in the business language. 8 9 Gauge champions the idea of **living/executable documentation**. 10 11 ## Why Gauge? 12 13 The communication breakdowns between Developers and Business Stakeholders is a common risk of software development. 14 15 Gauge is an advanced automation tool that allows requirements to be written in a way that will be understood by all roles in a project and help bridge the gap. 16 17 Some of its key features include: 18 19 * A rich markup based on [markdown](https://en.wikipedia.org/wiki/Markdown) 20 * Simple, Flexible and Rich Syntax 21 * Business Language Tests : Supports the concept of executable documentation 22 * Consistent Cross Platform/Language Support for writing test code. Currently [supported languages](http://getgauge.io/documentation/user/current/test_code/index.html). 23 * Open Source, so it could be shared freely and improved by others as well 24 * A modular architecture with [plugin](http://getgauge.io/documentation/user/current/plugins/index.html) support. 25 * Extensible through [plugins](http://getgauge.io/documentation/user/current/plugins/index.html) and Hackable 26 * Supports External Data Sources 27 * Helps you create Maintainable and Understandable test suites 28 * [IDE Support](http://getgauge.io/documentation/user/current/ide_support/index.html) 29 30 31 ## Looking for examples? 32 * Get gauge installers from the [download page](http://getgauge.io/get-started/index.html). 33 * [Getting started in 3 steps - Java](https://github.com/getgauge/gauge/wiki/Getting-Started-in-3-Steps) 34 * Other [example projects](http://getgauge.io/documentation/user/current/examples/examples.html) 35 * [Execute Specifications](http://getgauge.io/documentation/user/current/execution/index.html) 36 37 ##Help 38 39 Refer our [Troubleshooting](http://getgauge.io/documentation/user/current/troubleshooting/troubleshooting.html) guide. 40 41 ## Find out more 42 43 | **[User Docs] [userdocs]** | **[Setup Guide] [setup]** | **[Roadmap] [roadmap]** | **[Contributing] [contributing]** | 44 |:-------------------------------------:|:-------------------------------:|:-----------------------------------:|:---------------------------------------------:| 45 | [![i1] [userdocs-image]] [userdocs]<br>Learn more about using Gauge | [![i2] [setup-image]] [setup]<br> Getting started with Gauge | [![i3] [roadmap-image]] [roadmap]<br>Roadmap of Gauge Project | [![i4] [contributing-image]] [contributing]<br>How can you contribute to Gauge? | 46 47 48 ## Questions or need help? 49 50 Check out the **[Talk to us] (http://github.com/getgauge/gauge/wiki/Talk-to-us)** page on our wiki. 51 52 [userdocs-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png 53 [setup-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png 54 [roadmap-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png 55 [contributing-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png 56 57 [userdocs]:http://getgauge.io/documentation/user/current/index.html 58 [setup]:https://github.com/getgauge/gauge/wiki/Setting-up-Gauge 59 [roadmap]:http://github.com/getgauge/gauge/wiki/Product-Roadmap 60 [contributing]:CONTRIBUTING.md 61 62 ## Add your Badge! 63 Copy the text below and add it to the README.md of your project using Gauge. 64 65 ``` 66 [![Gauge Badge](http://getgauge.io/Gauge_Badge.svg)](http://getgauge.io) 67 ``` 68 69 ## License 70 71 ![GNU Public License version 3.0](http://www.gnu.org/graphics/gplv3-127x51.png) 72 Gauge is released under [GNU Public License version 3.0](http://www.gnu.org/licenses/gpl-3.0.txt) 73 74 ## Contributing 75 76 Please read the [guide](CONTRIBUTING.md) on contributing to Gauge. 77 78 ## Copyright 79 80 Copyright 2016 ThoughtWorks, Inc.