Skip to content

Commit 06594a5

Browse files
committed
added InstallationInstructions file
1 parent b7146e7 commit 06594a5

File tree

3 files changed

+31
-19
lines changed

3 files changed

+31
-19
lines changed

Code/TSqlFlex.sln

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
33
# Visual Studio 2013
4-
VisualStudioVersion = 12.0.30501.0
4+
VisualStudioVersion = 12.0.30626.0
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TSqlFlex", "TSqlFlex\TSqlFlex.csproj", "{5D764D2E-1BB8-41C7-8F82-428C687A2C6A}"
77
EndProject
@@ -11,6 +11,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TSqlFlex.Core.Tests", "TSql
1111
EndProject
1212
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{731915D2-50C6-45D7-AF99-EE5D85083991}"
1313
ProjectSection(SolutionItems) = preProject
14+
..\InstallationInstructions.md = ..\InstallationInstructions.md
1415
..\README.md = ..\README.md
1516
EndProjectSection
1617
EndProject

InstallationInstructions.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
T-SQL Flex Installation Instructions
2+
====================================
3+
4+
* Download the latest release from the [GitHub releases page](https://github.com/nycdotnet/TSqlFlex/releases).
5+
* Extract the contents of the ZIP file somewhere, for example `C:\ProgramData\T-SQL Flex\`
6+
* Install the [Red Gate SIP framework](http://documentation.red-gate.com/display/MA/Redistributing+the+framework).
7+
* Figure out if you have 32-bit or 64-bit Windows; it affects the next step.
8+
* Open Regedit and create or navigate to the below registry key:
9+
* If 32-bit Windows: `HKLM\SOFTWARE\Red Gate\SIPFramework\Plugins`
10+
* If 64-bit Windows: `HKLM\SOFTWARE\Wow6432Node\Red Gate\SIPFramework\Plugins`
11+
* Create a new registry string value (REG_SZ) there to point to the extracted TSqlFlex.dll.
12+
* For example: `C:\ProgramData\T-SQL Flex\TSqlFlex.dll`
13+
14+
**Using T-SQL Flex:**
15+
* Launch SQL Server Management Studio and click the T-SQL Flex button.
16+
* Type one or more queries in the top panel and click the Run'n'Rollback button.
17+
* 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.
18+
* You can also have your query scripted into an Excel sheet by selecting that in the dropdown.
19+
20+
**To uninstall T-SQL Flex:**
21+
* Simply delete the registry key and the extracted files and restart SSMS.
22+
23+
Please create issues on GitHub or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet).
24+
25+

README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,11 @@ T-SQL Flex can script out the returned schema and data of any T-SQL query simply
99

1010
![t-sql_flex_v0 0 5-alpha](https://cloud.githubusercontent.com/assets/3755379/4019547/009c5f90-2a77-11e4-80de-200656264af7.png)
1111

12-
1312
**To install T-SQL Flex:**
14-
* Download the latest release from the [GitHub releases page](https://github.com/nycdotnet/TSqlFlex/releases).
15-
* Install the [Red Gate SIP framework](http://documentation.red-gate.com/display/MA/Redistributing+the+framework).
16-
* Create a new registry string value (REG_SZ) in the appropriate location to point to the extracted TSQLFlex.dll:
17-
18-
|Architecture|Registry Value Location|
19-
|----|-----|
20-
|32-bit Windows|HKLM\SOFTWARE\Red Gate\SIPFramework\Plugins|
21-
|64-bit Windows|HKLM\SOFTWARE\Wow6432Node\Red Gate\SIPFramework\Plugins|
22-
*Example: name = "TSQLFlex", value = "C:\ExtractedFiles\TSqlFlex.dll"*
23-
* Launch SQL Server Management Studio and click the T-SQL Flex button.
24-
* Fix the window positioning (will be better in next release).
25-
* 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.
26-
27-
**To uninstall T-SQL Flex:**
28-
* Simply delete the registry key and the extracted files and restart SSMS.
29-
30-
Please create issues on GitHub or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet).
13+
Follow the instructions here:
14+
15+
**For Support**
16+
Please either create issues on GitHub, or reach out to Steve on Twitter at [@nycdotnet](https://twitter.com/nycdotnet).
3117

3218
**Patch notes:**
3319
* v0.0.6-alpha (2014-08-30):

0 commit comments

Comments
 (0)