From 2dee2039acdf0f9f615cc19d8732a9f4d03e9e15 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Sun, 10 Dec 2023 22:33:31 +0100 Subject: [PATCH] Add "Building from Source" section in README.md In this update, a "Building from Source" section was added to the README.md file. This section provides instructions on how to build and test the current project using the .NET 6 SDK or later. It also includes steps to run the Elsa.AllInOne.Web project. --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f1f73f79a..979e0e019 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Elsa Workflows -[Elsa](https://v3.elsaworkflows.io/) is a powerful workflow library that enables workflow execution within any .NET application. Elsa allows you to define workflows in various ways, including: +Elsa is a powerful workflow library that enables workflow execution within any .NET application. Elsa allows you to define workflows in various ways, including: - Writing C# code - Using a visual designer @@ -18,6 +18,7 @@ - [Console Example](#console-example) - [ASP.NET Example](#aspnet-example) - [Elsa Server + Elsa Studio](#elsa-server--elsa-studio) +- [Building from Source](#building-from-source) ## Documentation @@ -553,4 +554,28 @@ Your application should now be accessible at https://localhost:5001. The port nu ``` Username: admin Password: password -``` \ No newline at end of file +``` + +## Building from Source + +To build Elsa from source, you'll need: + +- .NET 6 SDK or later + +To build the solution, run the following command: + +```shell +dotnet build Elsa.sln +``` + +To run the tests, run the following command: + +```shell +dotnet test Elsa.sln +``` + +To run the Elsa.AllInOne.Web project, run the following command: + +```shell +dotnet run --project src/Elsa.AllInOne.Web/Elsa.AllInOne.Web.csproj +```