Skip to content

Commit

Permalink
improve installation section (#2058)
Browse files Browse the repository at this point in the history
  • Loading branch information
SabotageAndi committed Jul 23, 2020
1 parent 5b66481 commit 2d63962
Show file tree
Hide file tree
Showing 10 changed files with 134 additions and 428 deletions.
384 changes: 72 additions & 312 deletions docs/Installation/Configuration.md

Large diffs are not rendered by default.

19 changes: 0 additions & 19 deletions docs/Installation/Install-IDE-Integration.md

This file was deleted.

52 changes: 39 additions & 13 deletions docs/Installation/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,52 @@ _Note:_ If you are new to SpecFlow, we recommend checking out the [Getting Start

SpecFlow consists of three components:

* The **IDE Integration** that provides a customized editor and test generation functions within your IDE. This is provided as an extension for Visual Studio.
* The **IDE Integration** that provides a customized editor and test generation functions within your IDE.
* The **generator** that can turn Gherkin specifications into executable test classes, available from NuGet.
* The **runtime** required for executing the generated tests. There are different runtime assemblies compiled for different target platforms. These packages are also available from NuGet.

In order to install everything you need, you first have to install the IDE integration and then set up your project to work with SpecFlow using the NuGet packages.

## Installing the IDE Integration

The process of installing the IDE Integration packages depends on your IDE. If you are using Visual Studio, the easiest way is to search for “SpecFlow” in the online search in the extension manager (**Tools | Extensions and Updates**). For other IDE integrations and for the direct download links, see the [Install IDE Integration](Install-IDE-Integration.md) page.
The process of installing the IDE Integration packages depends on your IDE.

This step only needs to be performed once in Visual Studio.
### Visual Studio

We recommend installing the SpecFlow Visual Studio extension (IDE Integration), as this is the most convenient way of working with SpecFlow. An overview of the features provided by the integration can be found [here](../Tools/Visual-Studio-Integration.md).

**If you are using Deveroom, do not install the SpecFlow Visual Studio extension; you should only install one of these 2 extensions.**

The easiest way to install the IDE integration is to select **Tools\Extensions and Updates** from the menu and search for "SpecFlow" in the online gallery.

The integration packages can also be downloaded and installed separately from the Visual Studio Gallery:

* [VS2019 integration](https://marketplace.visualstudio.com/items?itemName=TechTalkSpecFlowTeam.SpecFlowForVisualStudio)
* [VS2017 integration](https://marketplace.visualstudio.com/items?itemName=TechTalkSpecFlowTeam.SpecFlowforVisualStudio2017)
* [VS2015 integration](https://marketplace.visualstudio.com/items?itemName=TechTalkSpecFlowTeam.SpecFlowforVisualStudio2015)

### MonoDevelop/XamarinStudio/Visual Studio for Mac

We don't maintain our own extension for MonoDevelop/XamarinStudio/Visual Studio for Mac. But our amazing community created on at <https://github.com/straighteight/SpecFlow-VS-Mac-Integration>.

### VSCode

We currently don't have our own extension for VSCode.

For creating new projects, we recommend to use our [.NET templates](../Installation/Project-and-Item-Templates.html#creating-a-new-project-from-the-template).

To improve your developing and scenario writing expierience, we recommend following VSCode extensions:

* [Cucumber (Gherkin) Full Support](https://marketplace.visualstudio.com/items?itemName=alexkrechik.cucumberautocomplete) - for editing feature files
* [.NET Core Test Explore](https://marketplace.visualstudio.com/items?itemName=formulahendry.dotnet-test-explorer) - for executing scenarios

### Rider

We currently don't have our own extension for Rider.

For creating new projects, we recommend to use our [.NET templates](../Installation/Project-and-Item-Templates.html#creating-a-new-project-from-the-template).

If you are interested in one, please up-vote this [feature-request](https://support.specflow.org/hc/en-us/community/posts/360012011397--SpecFlow-Rider-IDE-Support)

## Project Setup

Expand All @@ -23,13 +58,4 @@ The generator and runtime are usually installed together for each project. To in
1. Right-click on your project in Visual Studio, and select **Manage NuGet Packages** from the menu.
1. Switch to the **Browse** tab.
1. Enter "SpecFlow" in the search field to list the available packages for SpecFlow.
1. Install the required packages. You need to install the SpecFlow NuGet package ([SpecFlow](http://www.nuget.org/packages/SpecFlow])).
Other helper packages are also availble, e.g. [SpecFlow.NUnit](http://www.nuget.org/packages/SpecFlow.NUnit) or [SpecRun.SpecFlow](http://www.nuget.org/packages/SpecRun.SpecFlow). We recommend that you install the NuGet packages for your test framework.

You can also install NuGet package manager console, e.g.:

``` PowerShell
Install-Package SpecFlow -ProjectName MyApp.Specs
```

Refer to the [NuGet-Packages](NuGet-Packages.md) page a full list of supported NuGet packages. You can find more details on setting up your project on the [Setup SpecFlow Projects]() page.
1. Install the required NuGet packages. Depending on your chosen unit test provider, you have to use different packages. See [this list](Unit-Test-Providers.md) to find the correct package
4 changes: 2 additions & 2 deletions docs/Installation/NuGet-Packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ This package enables the code-behind file generation at build time.

#### >= 3.0

It is **mandatory** for projects to use. After SpecFlow 3.3.30 this is a dependency of the `SpecFlow.xUnit`, `SpecFlow.NUnit`, `SpecFlow.MSTest` and `SpecRun.SpecFlow.3-3-0` packages.
It is **mandatory** for projects to use. After SpecFlow 3.3.30 this is a dependency of the `SpecFlow.xUnit`, `SpecFlow.NUnit`, `SpecFlow.MSTest` and `SpecRun.SpecFlow.3-3-0` packages, hence the package is automatically installed with the unit test provider packages and you don't have to install it manually.

#### < 3.0

This package is optional, because the code- behind file generation is done in the most cases by Visual Studio. But it is highly recommended to use it.
This package is optional if the code-behind file generation is enabled in the Visual Studio Extension. However, we recommend to upgrade to the [MSBuild code behind file generation](../Tools/Generate-Tests-From-MsBuild.md).

### SpecFlow.xUnit

Expand Down
74 changes: 0 additions & 74 deletions docs/Installation/SpecFlow-and-.NET-Core.md

This file was deleted.

3 changes: 2 additions & 1 deletion docs/Tools/Generate-Tests-From-MsBuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## General

You need to use the MSBuild code behind file generation for SpecFlow 3.0.
Version after SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using the `SpecFlow.NUnit`, `SpecFlow.MSTest`, `SpecFlow.xUnit` or `SpecRun.SpecFlow.3-3-0` package.

After version SpecFlow 3.3.30 don't need to add the `SpecFlow.Tools.MSBuild.Generation` package anymore to your project, if you are using one of our [Unit-Test-Provider](../Installation/Unit-Test-Providers.md) NuGet packages.

**Note:** You will need at least VS2017/MSBuild 15 to use this package.

Expand Down
4 changes: 2 additions & 2 deletions docs/Tools/Visual-Studio-Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Visual Studio integration includes a number of features that make it easier to edit Gherkin files and navigate to and from bindings in Visual Studio. You can also generate skeleton code including step definition methods from feature files. The Visual Studio integration also allows you to execute tests from Visual Studio's Test Explorer.

You can install the integration from [Visual Studio Gallery](http://go.specflow.org/vsgallery) or from the online search in Visual Studio under **Tools/Extensions and Updates** (search for "SpecFlow"). Detailed instructions can be found [here](../Installation/Install-IDE-Integration.md).
You can install the integration from [Visual Studio Gallery](http://go.specflow.org/vsgallery) or from the online search in Visual Studio under **Tools/Extensions and Updates** (search for "SpecFlow"). Detailed instructions can be found [here](../Installation/Installation.md).

The integration provides the following features:

Expand Down Expand Up @@ -30,4 +30,4 @@ The integration provides the following features:

## Troubleshooting

If you are having trouble with the Visual Studio integration, refer to the [Troubleshooting page](../Installation/Troubleshooting-Visual-Studio-Integration.md) first.
If you are having trouble with the Visual Studio integration, refer to the [Troubleshooting page](../Help/Troubleshooting-Visual-Studio-Integration.md) first.
16 changes: 15 additions & 1 deletion docs/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,18 @@ a, a:visited, a:hover {

.wy-nav-content {
max-width: 80%;
}
}

/* override table width restrictions */
@media screen and (min-width: 767px) {

.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}

.wy-table-responsive {
overflow: visible !important;
}
}
6 changes: 2 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,10 @@ Indices and tables

Installation/Requirements.md
Installation/Installation.md
Installation/Configuration.md
Installation/Install-IDE-Integration.md
Installation/NuGet-Packages.md
Installation/Configuration.md
Installation/Project-and-Item-Templates.md
Installation/Troubleshooting-Visual-Studio-Integration.md
Installation/Unit-Test-Providers.md
Installation/SpecFlow-and-.NET-Core.md
Installation/Breaking-Changes-with-SpecFlow-3.0.md

.. toctree::
Expand Down Expand Up @@ -157,6 +154,7 @@ Indices and tables

Help/Troubleshooting.md
Help/Known-Issues.md
Help/Troubleshooting-Visual-Studio-Integration.md

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 2d63962

Please sign in to comment.