diff --git a/Code/TSqlFlex.sln b/Code/TSqlFlex.sln index 0e416b6..ad9c468 100644 --- a/Code/TSqlFlex.sln +++ b/Code/TSqlFlex.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 2013 -VisualStudioVersion = 12.0.30501.0 +VisualStudioVersion = 12.0.30626.0 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TSqlFlex", "TSqlFlex\TSqlFlex.csproj", "{5D764D2E-1BB8-41C7-8F82-428C687A2C6A}" EndProject @@ -11,6 +11,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TSqlFlex.Core.Tests", "TSql EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{731915D2-50C6-45D7-AF99-EE5D85083991}" ProjectSection(SolutionItems) = preProject + ..\InstallationInstructions.md = ..\InstallationInstructions.md ..\README.md = ..\README.md EndProjectSection EndProject diff --git a/InstallationInstructions.md b/InstallationInstructions.md new file mode 100644 index 0000000..9bb931b --- /dev/null +++ b/InstallationInstructions.md @@ -0,0 +1,25 @@ +T-SQL Flex Installation Instructions +==================================== + + * Download the latest release from the [GitHub releases page](https://github.com/nycdotnet/TSqlFlex/releases). + * Extract the contents of the ZIP file somewhere, for example `C:\ProgramData\T-SQL Flex\` + * Install the [Red Gate SIP framework](http://documentation.red-gate.com/display/MA/Redistributing+the+framework). + * Figure out if you have 32-bit or 64-bit Windows; it affects the next step. + * Open Regedit and create or navigate to the below registry key: + * If 32-bit Windows: `HKLM\SOFTWARE\Red Gate\SIPFramework\Plugins` + * If 64-bit Windows: `HKLM\SOFTWARE\Wow6432Node\Red Gate\SIPFramework\Plugins` + * Create a new registry string value (REG_SZ) there to point to the extracted TSqlFlex.dll. + * For example: `C:\ProgramData\T-SQL Flex\TSqlFlex.dll` + +**Using T-SQL Flex:** + * Launch SQL Server Management Studio and click the T-SQL Flex button. + * Type one or more queries in the top panel and click the Run'n'Rollback button. + * T-SQL Flex will run your query in the scope of an ADO.NET Transaction that is rolled-back when the batch completes. The schema returned from those queries will be scripted in the lower panel. + * You can also have your query scripted into an Excel sheet by selecting that in the dropdown. + +**To uninstall T-SQL Flex:** + * Simply delete the registry key and the extracted files and restart SSMS. + +Please create issues on GitHub or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet). + + diff --git a/README.md b/README.md index 2ae96f9..416db21 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,11 @@ T-SQL Flex can script out the returned schema and data of any T-SQL query simply ![t-sql_flex_v0 0 5-alpha](https://cloud.githubusercontent.com/assets/3755379/4019547/009c5f90-2a77-11e4-80de-200656264af7.png) - **To install T-SQL Flex:** - * Download the latest release from the [GitHub releases page](https://github.com/nycdotnet/TSqlFlex/releases). - * Install the [Red Gate SIP framework](http://documentation.red-gate.com/display/MA/Redistributing+the+framework). - * Create a new registry string value (REG_SZ) in the appropriate location to point to the extracted TSQLFlex.dll: - -|Architecture|Registry Value Location| -|----|-----| -|32-bit Windows|HKLM\SOFTWARE\Red Gate\SIPFramework\Plugins| -|64-bit Windows|HKLM\SOFTWARE\Wow6432Node\Red Gate\SIPFramework\Plugins| -*Example: name = "TSQLFlex", value = "C:\ExtractedFiles\TSqlFlex.dll"* - * Launch SQL Server Management Studio and click the T-SQL Flex button. - * Fix the window positioning (will be better in next release). - * Type one or more queries in the top panel and click the Run'n'Rollback button. T-SQL Flex will run your query in the scope of an ADO.NET Transaction that is rolled-back when the batch completes. The schema returned from those queries will be scripted in the lower panel. - -**To uninstall T-SQL Flex:** - * Simply delete the registry key and the extracted files and restart SSMS. - -Please create issues on GitHub or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet). +Follow the instructions here: + +**For Support** +Please either create issues on GitHub, or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet). **Patch notes:** * v0.0.6-alpha (2014-08-30):