Skip to content

Commit

Permalink
Added docs and screenshots in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
BugDiver committed May 14, 2018
1 parent 9db64de commit 8259b1d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 11 deletions.
61 changes: 50 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,39 @@ Spectacle

Generates HTML from Specification/Markdown files. This is a plugin for [gauge](http://getgauge.io).

Install through Gauge
---------------------
<img src="https://github.com/getgauge/spectacle/raw/master/images/spectacle.png" alt="Spectacle" style="width: 600px;"/>


Installation
------------

```
gauge install spectacle
```
To install a specific version of spectacle plugin use the ``--version`` flag.

Export to HTML
--------------
Run the following command to export to HTML in a Gauge project
```
gauge install spectacle --version $VERSION
```

### Offline Installation

Download the plugin zip from the [Github Releases](https://github.com/getgauge/spectacle/releases).

use the ``--file`` or ``-f`` flag to install the plugin from zip file.

```
gauge docs spectacle <path to specs dir>
gauge install spectacle --file ZIP_FILE_PATH
```

Build from Source
-----------------

### Requirements

### Build from Source

#### Requirements
* [Golang](http://golang.org/)

### Compiling
#### Compiling

```
go run build/make.go
Expand All @@ -39,7 +51,7 @@ For cross-platform compilation
go run build/make.go --all-platforms
```

### Installing
#### Installing
After compilation

```
Expand All @@ -59,6 +71,33 @@ For distributable across platforms: Windows and Linux for both x86 and x86_64
```
go run build/make.go --distro --all-platforms
```

Usage
-----

**Export to HTML**

Run the following command to export to HTML in a Gauge project

```
gauge docs spectacle <path to specs dir>
```

The html docs are generated in `docs` directory inside the project.

**Filter Specification/Scenario based on Tags**

Tags allow you to filter the specs and scenarios. Add the tags to the
textbox in the report to view all the specs and scenarios which are
labeled with certain tags. Tag expressions with operators ``|``, ``&``,
``!`` are supported.

In the following image, the specs/scenarios are filtered using a tag expression(\ ``refactoring & !api``).

<img src="https://github.com/getgauge/spectacle/raw/master/images/filter_tags.png" alt="filter" style="width: 600px;"/>



License
-------

Expand Down
Binary file added images/filter_tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/spectacle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8259b1d

Please sign in to comment.