Commit 3845cf13 authored by Stefan Holst's avatar Stefan Holst
Browse files

Removed linewrapping

parent 9539117a
Pipeline #176127180 passed with stages
in 22 minutes and 34 seconds
......@@ -7,7 +7,7 @@ OpenTAP x.y.z
**Steps to reproduce:**
1.
2.
2.
**Actual result:**
......@@ -16,3 +16,4 @@ OpenTAP x.y.z
**Expected result:**
**Other remarks:**
## Contribute to OpenTAP
Thank you for your interest in contributing to OpenTAP. Contributions includes
feature enhancement request, issue reporting, bug fixing...
Thank you for your interest in contributing to OpenTAP. Contributions includes feature enhancement request, issue reporting, bug fixing...
This guide details how to contribute to OpenTAP in a way that is efficient for
everyone.
This guide details how to contribute to OpenTAP in a way that is efficient for everyone.
## Contributor license agreement
......@@ -12,26 +10,19 @@ OpenTAP requires contributors to sign a contribution license agreement (CLA).
You can find the CLA [here](https://www.opentap.io/docs/OpenTAP%20Contributor%20License%20Agreement%20v2.pdf).
The CLA can be signed by an individual or a company. For companies, please add the company name and have a legal authorized representative endorsing the document.
* By submitting code as an individual you agree to the
individual contributor license agreement.
* By submitting code as an individual you agree to the individual contributor license agreement.
* By submitting code as an entity you agree to the
corporate contributor license agreement.
* By submitting code as an entity you agree to the corporate contributor license agreement.
Send the signed CLA to [CLA@opentap.io](mailto:CLA@opentap.io) together with
your Gitlab username and email address, and we will promote you to a developer
role in the OpenTAP project.
Send the signed CLA to [CLA@opentap.io](mailto:CLA@opentap.io) together with your Gitlab username and email address, and we will promote you to a developer role in the OpenTAP project.
## Contibuting Code
Once you have signed the CLA and have been added to the project, we welcome merge requests with fixes and improvements to OpenTAP code or documentation.
In the issue tracker, the label `Accepting Merge Requests` denotes issues that
we agree is a good idea and would really like merge requests for, but other
improvements are also most welcome.
In the issue tracker, the label `Accepting Merge Requests` denotes issues that we agree is a good idea and would really like merge requests for, but other improvements are also most welcome.
Issues labeled `To be Discussed` needs futher discussion. Try to resolve these
discussions, and get the label removed, before starting to work on these issues.
Issues labeled `To be Discussed` needs futher discussion. Try to resolve these discussions, and get the label removed, before starting to work on these issues.
Once you have identified an issue:
1. Assign it to yourself
......
# OpenTAP
OpenTAP is an Open Source project for fast and easy development and execution of
automated tests.
OpenTAP is an Open Source project for fast and easy development and execution of automated tests.
OpenTAP is built with simplicity, scalability and speed in mind, and is based on
an extendable architecture that leverages .NET Core.
OpenTAP is built with simplicity, scalability and speed in mind, and is based on an extendable architecture that leverages .NET Core.
OpenTAP offers a range of sequencing functionality and infrastructure that makes
it possible for you to quickly develop plugins tailored for your automation
needs – plugins that can be shared with the OpenTAP community through the
OpenTAP package repository.
OpenTAP offers a range of sequencing functionality and infrastructure that makes it possible for you to quickly develop plugins tailored for your automation needs – plugins that can be shared with the OpenTAP community through the OpenTAP package repository.
## Getting OpenTAP
If you are looking to use OpenTAP, you can get pre-built binaries at
[https://opentap.io/download.html](https://www.opentap.io/download.html).
If you are looking to use OpenTAP, you can get pre-built binaries at [https://opentap.io/download.html](https://www.opentap.io/download.html).
Using the OpenTAP CLI you are now able to download plugin packages from the
OpenTAP package repository.
Using the OpenTAP CLI you are now able to download plugin packages from the OpenTAP package repository.
To list and install plugin packages do the following in the command prompt:
......@@ -26,48 +19,30 @@ cd %TAP_PATH%
tap package list
```
We recommend that you download the Software Development Kit, or simply the
Developer’s System Community Edition provided by Keysight Technologies. The
Developer System is a bundle that contains the SDK as well as a graphical user
interface and result viewing capabilities. It can be installed by typing the
following:
We recommend that you download the Software Development Kit, or simply the Developer’s System Community Edition provided by Keysight Technologies. The Developer System is a bundle that contains the SDK as well as a graphical user interface and result viewing capabilities. It can be installed by typing the following:
```cmd
tap package install "Developer's System CE" -y
```
For a guide on how to develop using OpenTAP, check out our __[Developer
Guide](https://doc.opentap.io/Developer%20Guide/Introduction/#introduction)__,
it also exists as a
[PDF](https://www.opentap.io/docs/OpenTAP%20Developer%20Guide.pdf) for offline
reading. Note the
[source](https://gitlab.com/OpenTAP/opentap/blob/master/doc/Developer%20Guide/Readme.md)
can be found at GitLab as well.
For a guide on how to develop using OpenTAP, check out our __[Developer Guide](https://doc.opentap.io/Developer%20Guide/Introduction/#introduction)__, it also exists as a [PDF](https://www.opentap.io/docs/OpenTAP%20Developer%20Guide.pdf) for offline reading. Note the [source](https://gitlab.com/OpenTAP/opentap/blob/master/doc/Developer%20Guide/Readme.md) can be found at GitLab as well.
## Building OpenTAP
Most users build plugins for OpenTAP but if you are interested in building
OpenTAP yourself you can clone the git repository at
https://gitlab.com/OpenTAP/opentap and build the OpenTAP.sln solution file.
Most users build plugins for OpenTAP but if you are interested in building OpenTAP yourself you can clone the git repository at https://gitlab.com/OpenTAP/opentap and build the OpenTAP.sln solution file.
### Microsoft Windows 10
On Windows, Visual Studio 2017 or greater is needed to build. This can be done
by opening the solution and pressing F5, or Ctrl-Shift-B.
On Windows, Visual Studio 2017 or greater is needed to build. This can be done by opening the solution and pressing F5, or Ctrl-Shift-B.
**Note:** You need [Microsoft .NET Framework 4.6.2 Targeting
Pack](https://www.microsoft.com/en-us/download/details.aspx?id=53321) to build
OpenTAP for .NET Framework.
**Note:** You need [Microsoft .NET Framework 4.6.2 Targeting Pack](https://www.microsoft.com/en-us/download/details.aspx?id=53321) to build OpenTAP for .NET Framework.
### Linux / .NET Core
On Linux, you can build the source with .NET Core. You usually need to install
some dependencies in addition to .NET Core SDK. On Ubuntu, run the following on
apt:
On Linux, you can build the source with .NET Core. You usually need to install some dependencies in addition to .NET Core SDK. On Ubuntu, run the following on apt:
```sh
sudo apt install libc6-dev libunwind8 curl git -y
```
This should install the needed dependencies. Once these are installed, you can
build OpenTAP using these commands:
This should install the needed dependencies. Once these are installed, you can build OpenTAP using these commands:
```sh
dotnet build -c NetCore -r linux-x64
......@@ -77,8 +52,7 @@ dotnet publish -c NetCore -r linux-x64 tap/tap.csproj
*Note, the last line is there to ensure getting the right System.Runtime.dll.*
This creates a *Release* build. For a debug build set *NetCoreDebug* instead of
*NetCore* when building.
This creates a *Release* build. For a debug build set *NetCoreDebug* instead of *NetCore* when building.
## Testing
......@@ -86,8 +60,7 @@ OpenTAP can be tested using NUnit.
### Windows
Using Visual Studio 2017, open OpenTAP.sln and run the tests in the
TestExplorer.
Using Visual Studio 2017, open OpenTAP.sln and run the tests in the TestExplorer.
### Linux
......@@ -97,8 +70,7 @@ To run the entire test suite on Linux, run:
dotnet test -c NetCore # Or NetCoreDebug
```
To debug the unit tests, set the `VSTEST_HOST_DEBUG` environment variable to
`1`. This causes dotnet test to wait for a debugger to become attached.
To debug the unit tests, set the `VSTEST_HOST_DEBUG` environment variable to `1`. This causes dotnet test to wait for a debugger to become attached.
```sh
export VSTEST_HOST_DEBUG=1
......@@ -111,19 +83,13 @@ More documentation and help developing plugins for OpenTAP can be found here:
## Contributing
If you are thinking of contributing code to OpenTAP, first of all, thank you!
All fixes, patches and enhancements to OpenTAP are very warmly welcomed. In
order to keep thing manageable, there are a number of guidelines that should be
followed in order to ensure that your modification is included in OpenTAP as
quickly as possible. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
All fixes, patches and enhancements to OpenTAP are very warmly welcomed. In order to keep thing manageable, there are a number of guidelines that should be followed in order to ensure that your modification is included in OpenTAP as quickly as possible. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## Reporting Issues
We track issues at https://gitlab.com/OpenTAP/opentap/issues. You are welcome to
file an issue there if you have found a bug or have a concrete request for a new
feature. Please include a session log file if possible or relevant. Any other
files needed to reproduce an issue are also appreciated.
We track issues at https://gitlab.com/OpenTAP/opentap/issues. You are welcome to file an issue there if you have found a bug or have a concrete request for a new feature. Please include a session log file if possible or relevant. Any other files needed to reproduce an issue are also appreciated.
## License
This source code is subject to the terms of the Mozilla Public License, v2.0.
See full license in [LICENSE.txt](LICENSE.txt).
This source code is subject to the terms of the Mozilla Public License, v2.0. See full license in [LICENSE.txt](LICENSE.txt).
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment