diff --git a/README.md b/README.md index b18205a7..75954f4c 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,37 @@ or using it in a [WebApp](./examples/Zitadel.AspNet.AuthN) or To help developing the libraries, you may just open an issue or create a pull request to this repository. -To set up the dev environment you merely only need to -install the [.NET SDK](https://dotnet.microsoft.com/download) and you are good to go. +#### Prerequisites + +To set up the dev environment, you need to install: + +1. [.NET SDK](https://dotnet.microsoft.com/download) (8.x or later) +2. [Buf CLI](https://buf.build/docs/installation) - for protobuf code generation +3. [Just](https://github.com/casey/just) - task runner (installed via dotnet tools) + +#### Building the Project + +Follow these steps to build the project: + +1. **Install .NET tools (including Just):** + ```bash + dotnet tool restore + ``` + +2. **Generate gRPC code (required before first build):** + ```bash + just generate-grpc + ``` + +3. **Build the project:** + ```bash + dotnet build + ``` + +4. **Run tests:** + ```bash + dotnet test --configuration Release + ``` ##### License diff --git a/src/Zitadel/Zitadel.csproj b/src/Zitadel/Zitadel.csproj index a13ebd5b..20d8c00d 100644 --- a/src/Zitadel/Zitadel.csproj +++ b/src/Zitadel/Zitadel.csproj @@ -27,8 +27,8 @@ - - + + diff --git a/tests/Zitadel.Test/Zitadel.Test.csproj b/tests/Zitadel.Test/Zitadel.Test.csproj index 40a742ff..efe31475 100644 --- a/tests/Zitadel.Test/Zitadel.Test.csproj +++ b/tests/Zitadel.Test/Zitadel.Test.csproj @@ -1,7 +1,7 @@ - +