From 41ebed7cc88bb9a8603636b27b4a9d24e654e109 Mon Sep 17 00:00:00 2001 From: Joel Van Eenwyk Date: Sat, 1 Jun 2024 16:37:15 -0700 Subject: [PATCH] Update README with notice about this being a fork --- README.md | 94 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 0245112..3be6834 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,37 @@ -# LINQPad Driver LPRun Unit/Integration Tests Runner # +# LINQPad Driver LPRun Unit/Integration Tests Runner + +> [!WARNING] +> This is a work-in-progress fork of [LPRun](https://github.com/i2van/LPRun). Use at your own risk. [![Latest build](https://github.com/i2van/LPRun/workflows/build/badge.svg)](https://github.com/i2van/LPRun/actions) [![NuGet](https://img.shields.io/nuget/v/LPRun)](https://www.nuget.org/packages/LPRun) [![Downloads](https://img.shields.io/nuget/dt/LPRun)](https://www.nuget.org/packages/LPRun) [![License](https://img.shields.io/badge/license-MIT-yellow)](https://opensource.org/licenses/MIT) -## Table of Contents ## - -* [Description](#description) -* [LPRun .NET Versions](#lprun-net-versions) -* [Website](#website) -* [Download](#download) -* [Usage](#usage) - * [Setup](#setup) - * [LINQPad Test Script Example](#linqpad-test-script-example) - * [NUnit Test Example](#nunit-test-example) -* [Known Issues](#known-issues) - * [Unit-testing Frameworks Support](#unit-testing-frameworks-support) - * [LINQPad Runtime Reference](#linqpad-runtime-reference) -* [Troubleshooting](#troubleshooting) -* [Authors](#authors) -* [Credits](#credits) - * [Tools](#tools) - * [NuGet](#nuget) -* [Licenses](#licenses) - -## Description ## +## Table of Contents + +- [Description](#description) +- [LPRun .NET Versions](#lprun-net-versions) +- [Website](#website) +- [Download](#download) +- [Usage](#usage) + - [Setup](#setup) + - [LINQPad Test Script Example](#linqpad-test-script-example) + - [NUnit Test Example](#nunit-test-example) +- [Known Issues](#known-issues) + - [Unit-testing Frameworks Support](#unit-testing-frameworks-support) + - [LINQPad Runtime Reference](#linqpad-runtime-reference) +- [Authors](#authors) +- [Credits](#credits) + - [Tools](#tools) + - [NuGet](#nuget) +- [Licenses](#licenses) + +## Description The LPRun is the LINQPad driver's unit/integration tests runner. Can be used for testing [LINQPad 8](https://www.linqpad.net/LINQPad8.aspx)/[LINQPad 7](https://www.linqpad.net/LINQPad7.aspx)/[LINQPad 6](https://www.linqpad.net/LINQPad6.aspx) drivers or for running LINQPad scripts. -## LPRun .NET Versions ## +## LPRun .NET Versions .NET versions supported by LPRun are listed below. In case of unsupported version LPRun fallbacks to the latest production .NET installed. @@ -46,19 +48,19 @@ Use the following script to check the .NET version used by LPRun: System.Environment.Version ``` -## Website ## +## Website The LPRun is used for testing of the [CsvLINQPadDriver for LINQPad 8/7/6/5](https://github.com/i2van/CsvLINQPadDriver). -## Download ## +## Download [![NuGet](https://img.shields.io/nuget/v/LPRun)](https://www.nuget.org/packages/LPRun) -## Usage ## +## Usage Tested driver **MUST NOT** be installed via NuGet into LINQPad. In this case LPRun will use it instead of local one. -### Setup ### +### Setup 1. Create test project. 2. Add LPRun [![NuGet](https://img.shields.io/nuget/v/LPRun)](https://www.nuget.org/packages/LPRun) @@ -70,7 +72,7 @@ LPRun # Created by LPRun NuGet. Data # Optional: Driver data files. ``` -### LINQPad Test Script Example ### +### LINQPad Test Script Example LPRun executes LINQPad test script. Test script uses [Fluent Assertions](https://github.com/fluentassertions/fluentassertions) for assertion checks. @@ -92,7 +94,7 @@ original.GetHashCode() `Reason()` method (prints exact line number if assertion fails) and `context` variable are injected by [test](https://github.com/i2van/CsvLINQPadDriver/blob/master/Tests/CsvLINQPadDriverTest/LPRunTests.cs) [below](#nunit-test-example). -### NUnit Test Example ### +### NUnit Test Example Full NUnit test code can be found [here](https://github.com/i2van/CsvLINQPadDriver/blob/master/Tests/CsvLINQPadDriverTest/LPRunTests.cs). @@ -230,13 +232,13 @@ public class LPRunTests } ``` -## Known Issues ## +## Known Issues -### Unit-testing Frameworks Support ### +### Unit-testing Frameworks Support Tested with [NUnit](https://github.com/nunit/nunit). Other test frameworks should work as well. -### LINQPad Runtime Reference ### +### LINQPad Runtime Reference Avoid referencing `LINQPad.Runtime.dll` in your tests, e.g. for [Moq](https://github.com/moq/moq4): @@ -264,25 +266,25 @@ var driverProperties = Mock.Of(props => ); ``` -## Authors ## +## Authors -* [Ivan Ivon](https://github.com/i2van) -* [LINQPad.Runtime](https://www.linqpad.net/LINQPad8.aspx)/[LPRun](https://www.linqpad.net/lprun.aspx) binaries ([license](https://www.linqpad.net/eula.txt)) by [Joseph Albahari](https://www.albahari.com/) +- [Ivan Ivon](https://github.com/i2van) +- [LINQPad.Runtime](https://www.linqpad.net/LINQPad8.aspx)/[LPRun](https://www.linqpad.net/lprun.aspx) binaries ([license](https://www.linqpad.net/eula.txt)) by [Joseph Albahari](https://www.albahari.com/) -## Credits ## +## Credits -### Tools ### +### Tools -* [LINQPad 8](https://www.linqpad.net/LINQPad8.aspx) -* [LINQPad Command-Line and Scripting](https://www.linqpad.net/lprun.aspx) +- [LINQPad 8](https://www.linqpad.net/LINQPad8.aspx) +- [LINQPad Command-Line and Scripting](https://www.linqpad.net/lprun.aspx) -### NuGet ### +### NuGet -* [Fluent Assertions](https://github.com/fluentassertions/fluentassertions) -* [Moq](https://github.com/moq/moq4) -* [NUnit](https://github.com/nunit/nunit) +- [Fluent Assertions](https://github.com/fluentassertions/fluentassertions) +- [Moq](https://github.com/moq/moq4) +- [NUnit](https://github.com/nunit/nunit) -## Licenses ## +## Licenses -* [LICENSE](https://github.com/i2van/LPRun/blob/main/LICENSE) ([MIT](https://opensource.org/licenses/MIT)) -* [LINQPad End User License Agreement](https://www.linqpad.net/eula.txt) +- [LICENSE](https://github.com/i2van/LPRun/blob/main/LICENSE) ([MIT](https://opensource.org/licenses/MIT)) +- [LINQPad End User License Agreement](https://www.linqpad.net/eula.txt)