Skip to content

Commit 1c78b37

Browse files
authored
Update README.md
1 parent f4378aa commit 1c78b37

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,11 @@ the generated code to my liking.
1919

2020
[Click here](https://github.com/sjh37/EntityFramework-Reverse-POCO-Code-First-Generator/releases) to see what's new in this release.
2121

22-
### Donation
23-
24-
To make a donation via PayPal, [please click here](https://www.paypal.me/SJH37).
25-
2622
### Supported databases
2723

2824
* SQL Server
2925
* SQL Server Compact 3.5 and 4.0
26+
* Comming soon: Oracle, PostgreSQL, MySQL
3027

3128
### Highly customisable output
3229

@@ -40,29 +37,38 @@ If your database changes, simply re-save the `<database>.tt` file. That's it.
4037

4138
### To install and use this project:
4239

43-
* For Visual Studio 2012 & 2013, install Entity Framework 6 Tools
40+
- EF 6
41+
* For Visual Studio 2012 & 2013, install Entity Framework 6 Tools
4442
[available here](http://www.microsoft.com/en-us/download/details.aspx?id=40762)
4543
This installs the required EF6.Utility.CS.ttinclude which is used for pluralisation
4644
You only need to do this once.
47-
* Use Nuget and install EntityFramework.
48-
* Add a connect string to your app.config. Something like:
45+
* Use Nuget and install EntityFramework.
46+
* Add a connect string to your app.config. Something like:
4947
```xml
5048
<connectionStrings>
5149
<add name="MyDbContext"
5250
providerName="System.Data.SqlClient"
5351
connectionString="Data Source=(local);Initial Catalog=MyDatabase;Integrated Security=True;" />
5452
</connectionStrings>
5553
```
54+
- .NET Core
55+
* Use Nuget and install the relevant nuget package for your datbase, such as `Microsoft.EntityFrameworkCore.SqlServer`
56+
5657
* The connection string you use must have at least these privileges: `ddladmin`, `datareader` and `datawriter`.
5758
`ddladmin` is required for reading the default constraints.
5859
* In Visual Studio, right click project and select "add - new item".
5960
* Select Online, and search for **reverse poco**.
6061
* Select **EntityFramework Reverse POCO Generator**.
6162
* Give the file a name, such as `Database.tt` and click Add.
62-
* Edit the `Database.tt` file and specify the connection string as "**MyDbContext**" which matches your name in `app.config`.
63-
* Save the `Database.tt` file, which will now generate the `Database.cs` file.
64-
* There are many options you can use to customise the generated code.
65-
All of these settings are in the `Database.tt` files.
63+
64+
- .NET Core
65+
* Edit the `Database.tt` file and specify the full connection string in `Settings.ConnectionString`. This is used by the generater to read your database schema and reverse engineer it.
66+
* Edit the `Database.tt` file and specify the connection string in `Settings.ConnectionStringName` which matches the ConnectionString key as specified in your `appsettings.json`, `app.config` or `web.config`.
67+
- EF 6
68+
* Edit the `Database.tt` file and specify the connection string as "**MyDbContext**" which matches your name in `app.config`.
69+
70+
* Save the `Database.tt` file, which will now generate the `Database.cs` file. Every time you save your `Database.tt` file, the generator will run and reverse engineer your database.
71+
* There are many options you can use to customise the generated code. All of these settings are in the `Database.tt` files.
6672

6773
### UI
6874

@@ -72,20 +78,21 @@ A simple UI for the generator is available at
7278
### Editing TT (T4) Files
7379
To have full syntax highlighting and intellisense when editing TT files, I use the Resharper plugin ForTea. I can't imagine editing TT files without it.
7480

81+
With the new v3, you no longer have to edit the `EF.Reverse.POCO.v3.ttinclude` file as this file is now generated from a C# project. This repository includes the BuildTT file which creates the `EF.Reverse.POCO.v3.ttinclude` from the `Generator` C# project.
82+
7583
### Getting a pull request accepted
7684
Have a read of [https://github.com/blog/1943-how-to-write-the-perfect-pull-request](How to write the perfect pull request)
7785

7886
My requirements are simple:
7987

8088
1. Always keep the changes to a **minimum**, so I can see **exactly** what's changed in regard to the pull request. I.e. No whitespace tidy up, etc.
8189
2. No tabs, only spaces (4).
82-
3. Don't move functions about, please leave them where they are.
83-
4. No new files. This will always get rejected. Add any new code/classes into the two existing .ttinclude files.
84-
5. Don't be tempted to do a few different enhancements in one pull request. Have **one** pull request for **one** bug fix / enhancement.
90+
3. Edit the Generator C# project, as this is what is used to create the `EF.Reverse.POCO.v3.ttinclude` file. This repository includes the `BuildTT` project which creates the `EF.Reverse.POCO.v3.ttinclude` from the `Generator` C# project.
91+
4. Don't be tempted to do a few different enhancements in one pull request. Have **one** pull request for **one** bug fix / enhancement.
8592

8693
Regards,
8794
Simon Hughes
8895

89-
* E: [simon@hicrest.net](mailto:simon@hicrest.net)
96+
* E: [simon@reversepoco.co.uk](mailto:simon@reversepoco.co.uk)
9097
* W: [about.me/simon.hughes](http://about.me/simon.hughes)
9198
* B: [simon-hughes.blogspot.co.uk](http://simon-hughes.blogspot.co.uk)

0 commit comments

Comments
 (0)