Skip to content

Commit 6e3fcac

Browse files
committed
Updating README.md
1 parent f314586 commit 6e3fcac

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

‎README.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,22 @@ The name of this sample database was based on the Northwind database. Chinooks a
3636

3737
System Requirements:
3838
* [.NET 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
39-
* dotnet-t4 (command-line tool for processing T4 templates): `dotnet tool install --global dotnet-t4`
39+
* [dotnet-t4](https://www.nuget.org/packages/dotnet-t4/) (command-line tool for processing T4 templates): `dotnet tool install --global dotnet-t4`
4040

4141
Notes:
42+
* You only need the `dotnet` and `dotnet-t4` tools to build and generate the scripts in any OS (macOS, Linux, or Windows).
43+
* If you need an IDE, you can use [Visual Studio Code](https://code.visualstudio.com) and install the recommended plugins. Alternatively, you can also use JetBrains Rider or Visual Studio Community Edition (Windows only).
4244
* The SQL scripts are auto-generated using [Text Template Transformation](https://learn.microsoft.com/en-us/visualstudio/modeling/code-generation-and-t4-text-templates?view=vs-2022).
4345
* The `ChinookDataSet.xsd` file contains the schema definition, `ChinookData.json` contains the data, and the `*.tt` files are the text templates that are used to generate all SQL scripts.
44-
* You can build the solution using any IDE (Visual Studio Community Edition, Visual Studio Code, Jetbrains Rider) or using `dotnet build` in any OS (macOS, Linux, Windows).
46+
47+
Build, auto-generate the SQL scripts, and testing:
48+
```bash
49+
# Build and generate the SQL scripts.
50+
dotnet build
51+
52+
# Start the local databases to test the generated scripts.
53+
docker compose up -d
54+
55+
# Run all the tests.
56+
dotnet test
57+
```

0 commit comments

Comments
 (0)