From b70c89745e3dd9eb75a8810b5d3edc566e8694a8 Mon Sep 17 00:00:00 2001 From: "Wyatt J. Miller" Date: Sat, 2 Jul 2022 14:37:15 -0400 Subject: [PATCH] updated readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 4bc5466..e12913e 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ I also ripped out the legacy .NET Framework and put .NET 6 in it's place, which Think WPF but cross platform. Avalonia still runs your favorite declarative language, XAML, but applies a different drawing library, Skia (SkiaSharp). What Skia allows Avalonia to do is draw windows, buttons, and other widgets on not just Windows, but macOS, Linux, Android, and iOS. Even Web Assembly! Learn more [here](http://avaloniaui.net/). +###### 🚧👷‍♂️ All developers! Wear your hard hats! 🚧👷‍♂️ + +This application is still in the porting process. Don't worry though! It's being worked on. Please file an [issue]() if find anything that shouldn't be happening. + ## Building ### Requirements @@ -46,6 +50,8 @@ Clone using the following command: ### Deployment +All build tasks go through the `dotnet` command. + If you want to build for development, run: `dotnet run --project DeskHubSharpRevised/DeskHubSharpRevised.csproj` @@ -58,6 +64,8 @@ If you want to build for production for Windows, run: `dotnet publish DeskHubSharpRevised/DeskHubSharpRevised.csproj --configuration Release --framework net6.0 --output publish --self-contained True --runtime win-x64 --verbosity Normal /property:PublishTrimmed=True /property:PublishSingleFile=True /property:IncludeNativeLibrariesForSelfExtract=True /property:DebugType=None /property:DebugSymbols=False` +These tasks are supposed to be replaced with Cake in the near future. + ## Documentation To see the developer documentation, please run the following command in Powershell/bash: @@ -73,3 +81,5 @@ Also note that this step is optional. This step only generates documentation, wh ## Contribution Issues and pull requests are more than welcome. + +I don't have a style guide yet.