From 04a334faf708cb0467a644adea15d904139bf0c3 Mon Sep 17 00:00:00 2001 From: Robert Muehsig Date: Tue, 17 Oct 2017 23:48:02 +0200 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2ba8976..f9f2c63 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,34 @@ Master: [![Build status](https://ci.appveyor.com/api/projects/status/u710d6hman5 Build cross platform desktop apps with .NET Core and ASP.NET NET Core. +# Usage: + +* To communicate with the "native" (sort of native...) Electron API include the [ElectronNET.API NuGet package](https://www.nuget.org/packages/ElectronNET.API/) in your ASP.NET Core app. + +* For the tooling you will need your dotnet-electronize package [ElectronNET.CLI NuGet package](https://www.nuget.org/packages/ElectronNET.CLI/). This package __must__ be referenced in the .csproj like this: + + + + + +* Make sure you have node.js and on OSX/Ubuntu the electron-packager installed (via "sudo npm install electron-packager --global") +* In your ASP.NET Core folder run: + + dotnet electronize init + +* Now a electronnet.manifest.json should appear in your ASP.NET Core project +* Now run the following: + + dotnet electronize build + +* In your default setting we just build the application for the OS you are running (Windows builds Windows, OSX builds OSX etc.), but this can be changed with: + + dotnet electronize build win + dotnet electronize build osx + dotnet electronize build linux + +* The end result should be a electron app under your /bin/desktop folder + ## Dev Notes: Currently there are two main projects and a "WebApp" that serves as a demo playground. @@ -13,12 +41,7 @@ Currently there are two main projects and a "WebApp" that serves as a demo playg Both projects create their own nuget package. The resulting nuget packages are saved under "/artifacts". -__Currently__ the packages are just build with version 1.0.0. -If you change something you need to clear the nuget cache under this directory (because the version number doesn't change): - - %userprofile%\.nuget\packages - -The solution contains a NuGet.config which points to the artifacts directory, so we can just use the produced NuGet packages without uploading to NuGet.org. +__Currently__ the packages are just build with version 1.0.0 on your machine. NuGet might pick the wrong version from its own cache, so please read the dev notes if you want to develop! __ElectronNET.WebApp:__ @@ -28,11 +51,7 @@ The WebApp now has referenced the API NuGet package and via the .csproj referenc -## Dev Notes: Usage -Navigate to the WebApp folder and type this in a command prompt: - - dotnet electronize # Dev Notes: Dev Workflow