Initial commit

Author: Gert Marginet

README.md

@@ -1 +1,68 @@
-# SqlQueryTools
+# SqlQueryTools
+
+SqlQueryTools is a visual studio extension that generates code behind files for sql files.
+The code behinde file contains a static class with the same name as the sql file.
+That class has a const called query, with the content of the sql file.
+It also contains a const for every parameter that is declared in the sql file.
+
+Before SqlQueryTools start generating the code behind file it validates the content of the sql file with a SQL Server database.
+
+The generated code can be used to execute the query with an ORM like [Dapper](https://github.com/DapperLib/Dapper)
+
+### Download
+
+Download from [releases](https://github.com/gmarginet/SqlQueryTools/releases)
+
+### Getting started
+
+You can add a new sql file by right clicking on a .cs file and select 'Sql Query Tools/Add Sql File'.
+This will add a nested sql file below the selected csharp file.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/AddSqlFile.png)
+
+The following dialog will pop up, enter the filename and click 'Add file'.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/AddNewSqlFileDialog.png)
+
+The added sql file will have the following content.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/SqlFileDefaultContent.png)
+
+Before you start writing your query you should set the SQL server connection string that Sql Query Tools should use to validate the query.
+The connection string can be set in the .csproj file you just added the sql file to.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/ConnectionString.png)
+
+Now you can start writing your sql query.
+You can remove all comments but if you use parameters in your query you should put the parameter declarations above the 'End Of Parameter Declaration' marker.
+And your actual query below the marker.
+The generated const string will only contain the lines below the marker, if the sql file doesn't contain a marker line all lines will be put in the const string.
+
+All comments that you keep in your sql file will not be put in the const string.
+
+Below you can find an example of a query.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/ExampleSql.png)
+
+When you save the sql file, Sql Query Tools will start generating the code behind.
+The progress can be found in the Sql Query Tools output panel.
+Here you will also find more info when something went wrong.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/OutputPanel.png)
+
+And the generated code for the example query from above will look like this.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/ExampleCode.png)
+
+The solution explorer will now look like this.
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/SolutionExplorer.png)
+
+If you don't like the file suffixes or the parameter declaration marker.
+These can be changed via 'Tools/Options/SqlQueryTools
+
+![image](https://github.com/gmarginet/SqlQueryTools/blob/master/art/Options.png)
+
+### License
+
+MIT