Skip to content
This repository was archived by the owner on Nov 7, 2019. It is now read-only.

Commit de47bc2

Browse files
authored
#69 Clarify .NET target frameworks
Attempt to reduce the confusion of the project name
1 parent dc620e1 commit de47bc2

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,40 +52,43 @@ Update your project:
5252
</ItemGroup>
5353
```
5454

55-
3. Add a `precompile` script:
55+
3. Add a precompile script:
5656

5757
```xml
5858
<Target Name="PrecompileScript" BeforeTargets="BeforeBuild">
5959
<Exec Command="dotnet SpecFlow.NetCore" />
6060
</Target>
6161
```
6262

63-
4. Build for your tests to be discovered.
63+
4. Build for your tests to be discovered.
6464

65-
### Notes
65+
Note: there is [a bug with the .NET Core CLI requiring a second build for newly added files to be discovered](https://github.com/stajs/SpecFlow.NetCore/issues/22).
6666

67-
- There is [a bug with the .NET Core CLI requiring a second build for newly added files to be discovered](https://github.com/stajs/SpecFlow.NetCore/issues/22).
68-
- Support for the .NET Core switch from `project.json` to MSBuild `.csproj` was added by the community in February 2017 (thanks @richardjharding!) but has not yet been officially tested.
67+
## .NET target frameworks
6968

70-
### Samples
69+
:warning: **SpecFlow itself (and by extension this project) is currently limited to Windows platforms with full .NET Framework v4.5.1+**
7170

72-
If you build the [samples](https://github.com/stajs/SpecFlow.NetCore/tree/master/samples/) solution, you should see `.feature.cs` files and an `app.config` being generated for each test framework.
71+
This means that the following are unsupported:
72+
73+
- Non-Windows platforms.
74+
- [Target frameworks](https://docs.microsoft.com/en-us/dotnet/standard/frameworks) other than `.NET Framework`.
75+
- `.NET Framework` TFMs below `net451`.
7376

74-
## Supported frameworks
77+
This project will not work with the `.NET Core Application` target framework (e.g. `netcoreapp2.0`). If you find it confusing that this project includes "NetCore" in the name, yet it only supports `.NET Framework` and not `.NET Core Application`, remember the above limitation of SpecFlow and that it is a legitimate usage of a [.NET Core package](https://docs.microsoft.com/en-us/dotnet/core/packages):
7578

76-
### .NET Core
79+
> .NET Core is a platform made of NuGet packages.
80+
>
81+
> Each of the .NET Core packages support being run on multiple .NET implementations, represented as frameworks. Some of those frameworks are traditional frameworks, like net46, representing the .NET Framework.
82+
83+
The following TFMs are officially supported:
7784

78-
- ~~`netcoreapp2.0`~~ (see [#39](https://github.com/stajs/SpecFlow.NetCore/issues/39))
7985
- `net46`
8086
- `net461`
8187

82-
SpecFlow itself, and by extension this project, is currently limited to running on full .NET Framework.
88+
Other TFMs of `net451` and above should support SpecFlow and this project, but have not been officially tested.
89+
8390

84-
### Test frameworks
8591

86-
- [xUnit](https://xunit.github.io/)
87-
- [NUnit](http://www.nunit.org/) - _Experimental support added by the community._
88-
- [MsTest](https://blogs.msdn.microsoft.com/visualstudioalm/2016/05/30/announcing-mstest-framework-support-for-net-core-rc2-asp-net-core-rc2/) - _Experimental support added by the community._
8992

9093
## Visual Studio
9194

@@ -117,6 +120,10 @@ One of the nice features from the VS extension is being able to easily generate
117120
Given this should be a short-lived solution, hopefully this workaround is tolerable.
118121
-->
119122

123+
## Samples
124+
125+
If you build the [samples](https://github.com/stajs/SpecFlow.NetCore/tree/master/samples/) solution, you should see `.feature.cs` files and an `app.config` being generated for each test framework.
126+
120127
## Background
121128

122129
- [SpecFlow Issue 471](https://github.com/techtalk/SpecFlow/issues/471): Auto generation of `feature.cs` fails when using MSBuild that comes with VS2015

0 commit comments

Comments
 (0)