From 1b86cc17e27b463ae8fa7e29554c67ef43be99f3 Mon Sep 17 00:00:00 2001 From: FransBouma Date: Wed, 2 Jul 2014 11:37:57 +0200 Subject: [PATCH] Readme update --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 54689b5..16eb804 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,35 @@ -LINQPadDriver -============= -The Official LLBLGen Pro LINQPad driver. This repository is the continuation of the Codeplex repository at +LLBLGen Pro LINQPad Driver +=========================== +The Official [LLBLGen Pro](http://www.llblgen.com) LINQPad driver. This repository is the continuation of the Codeplex repository at https://llblgenlinqpad.codeplex.com/. For the sourcecode of the Linqpad driver for LLBLGen Pro v4.1 or earlier please visit the codeplex repository. -How to compile the sourcecode ------------------------------------ +###How to compile the sourcecode To compile the sourcecode, make sure you place the files mentioned in \Externals\FilesToPlaceHere.txt into the folder \Externals before compiling. It can be DevDeploy(4).bat fails after compilation. Adjust the paths in those bat files or remove the post-build event. If you copied LINQPad.exe v4.40 or higher in the Externals folder, you have to change the target framework to .NET 4 for the driver project to compile the code. -Requirements to compile the code: ------------------------------------ +###Requirements to compile the code: .NET 3.5 SDK or higher. Recommented: VS.NET 2010, 2012 or 2013 (preferred). -How to distribute the driver ------------------------------------- +###How to distribute the driver To distribute the driver, zip the dll and header.xml into a zip file and rename the extension to .lpx. -Executing SQL ------------------- +###Executing SQL The driver isn't designed to be used to execute SQL against a database, though it will work if the following is true: - You specify a connection string in the connection dialog - In the connection string specified you connect to a SQL Server service. -Executing QuerySpec or Low-level API queries ----------------------------------------------- +###Executing QuerySpec or Low-level API queries Set the 'language' combo box in the query pane in LINQpad to 'C# Statements' or 'VB.NET statements'. Specify the query as-is. To see results, use the Dump(); extension method by appending it to the results. For Adapter, obtain the adapter from the property 'AdapterToUse'. See the example below: +```C# // Queryspec: var qf = new QueryFactory(); var results = this.AdapterToUse.FetchQuery(qf.Customer); @@ -43,3 +39,4 @@ results.Dump(); var managers = new EntityCollection(); this.AdapterToUse.FetchEntityCollection(managers, null); managers.Dump(); +``` \ No newline at end of file