diff --git a/README.md b/README.md index f47b46b..812cddb 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,9 @@ Also you should have installed: - Install the following two nuget packages: ```ps1 -PM> Install-Package ElectronNET.Core +dotnet add package ElectronNET.Core -PM> Install-Package ElectronNET.Core.AspNet +dotnet add package ElectronNET.Core.AspNet ``` ### Enable Electron.NET on Startup diff --git a/docs/Core/Migration-Guide.md b/docs/Core/Migration-Guide.md index 3602f08..39ca173 100644 --- a/docs/Core/Migration-Guide.md +++ b/docs/Core/Migration-Guide.md @@ -16,13 +16,13 @@ Before starting the migration: **Uninstall old packages:** ```powershell -PM> Uninstall-Package ElectronNET.API +dotnet remove package ElectronNET.API ``` **Install new packages:** ```powershell -PM> Install-Package ElectronNET.Core -PM> Install-Package ElectronNET.Core.AspNet # For ASP.NET projects +dotnet add package ElectronNET.Core +dotnet add package ElectronNET.Core.AspNet # For ASP.NET projects ``` > **Note**: The API package is automatically included as a dependency of `ElectronNET.Core`. See [Package Description](../RelInfo/Package-Description.md) for details about the package structure. diff --git a/docs/GettingStarted/ASP.Net.md b/docs/GettingStarted/ASP.Net.md index 6fe239b..953a641 100644 --- a/docs/GettingStarted/ASP.Net.md +++ b/docs/GettingStarted/ASP.Net.md @@ -12,7 +12,11 @@ See [System Requirements](../GettingStarted/System-Requirements.md). ### 1. Create ASP.NET Core Project -Create a new ASP.NET Core Web App in Visual Studio: +#### Visual Studio + +Create a new ASP.NET Core Web App in Visual Studio by selecting **New Project** and choosing one of the ASP.NET Core project templates. + +#### From the command line ```bash dotnet new webapp -n MyElectronWebApp @@ -21,14 +25,20 @@ cd MyElectronWebApp ### 2. Install NuGet Packages +#### Visual Studio + +Right-click the solution and select **Manage Nuget Packages**. +Finr and install `ElectronNET.Core` as well as `ElectronNET.Core.AspNet`. + +#### From the command line + ```powershell -PM> Install-Package ElectronNET.Core -PM> Install-Package ElectronNET.Core.AspNet +dotnet add package ElectronNET.Core +dotnet add package ElectronNET.Core.AspNet ``` - > [!Note] -> `ElectronNET.Core.AspNet` provides ASP.NET-specific runtime components and should be used alongside `ElectronNET.Core`. +> The API package is automatically included as a dependency of `ElectronNET.Core`. ### 3. Configure Program.cs diff --git a/docs/GettingStarted/Console-App.md b/docs/GettingStarted/Console-App.md index 2fcad0e..f9efe16 100644 --- a/docs/GettingStarted/Console-App.md +++ b/docs/GettingStarted/Console-App.md @@ -22,7 +22,11 @@ See [System Requirements](../GettingStarted/System-Requirements.md). ### 1. Create Console Application -Create a new Console Application project in Visual Studio: +#### Visual Studio + +Create a new console application in Visual Studio by selecting **New Project** and choosing one of the project templates for console apps. + +#### From the command line ```bash dotnet new console -n MyElectronApp @@ -32,7 +36,7 @@ cd MyElectronApp ### 2. Install NuGet Packages ```powershell -PM> Install-Package ElectronNET.Core +dotnet add package ElectronNET.Core ``` > [!Note] diff --git a/docs/Home.md b/docs/Home.md index c46852f..a338d81 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -34,19 +34,16 @@ Electron.NET Core is a complete modernization of Electron.NET that eliminates th ## 🛠 System Requirements -- **.NET 8.0** or later -- **Node.js 22.x** or later -- **Visual Studio 2022** (recommended) or other .NET IDE -- **WSL2** (for Linux development on Windows) +See [System Requirements](GettingStarted/System-Requirements.md). ## 💡 Key Benefits -✅ **No CLI Tools Required** - Everything works through Visual Studio -✅ **Console App Support** - Use any HTML/JS source, not just ASP.NET -✅ **True Cross-Platform** - Build Linux apps from Windows -✅ **Modern Debugging** - Hot Reload and ASP.NET-first debugging -✅ **Flexible Packaging** - Choose any Electron version -✅ **MSBuild Integration** - Leverages .NET's build system +✅ **No CLI Tools Required** - Everything works through Visual Studio +✅ **Console App Support** - Use any HTML/JS source, not just ASP.NET +✅ **True Cross-Platform** - Build Linux apps from Windows +✅ **Modern Debugging** - Hot Reload and ASP.NET-first debugging +✅ **Flexible Packaging** - Choose any Electron version +✅ **MSBuild Integration** - Leverages .NET's build system ## 🚦 Getting Started @@ -58,4 +55,5 @@ New to ElectronNET.Core? Start here: ## 🤝 Contributing -Found an issue or want to improve the documentation? Contributions are welcome! The wiki is auto-generated from the `/docs` folder in the [GitHub repository](https://github.com/ElectronNET/Electron.NET). +Found an issue or want to improve the documentation? Contributions are welcome! +The wiki is auto-generated from the `/docs` folder in the [GitHub repository](https://github.com/ElectronNET/Electron.NET). diff --git a/docs/Using/Debugging.md b/docs/Using/Debugging.md index 1672206..3c7f5c4 100644 --- a/docs/Using/Debugging.md +++ b/docs/Using/Debugging.md @@ -123,8 +123,14 @@ Add the debugging profiles to `Properties/launchSettings.json`: When switching between Windows and WSL debugging: 1. **Right-click your project** in Solution Explorer -2. **Select "Edit Project File"** -3. **Update the RuntimeIdentifier**: +2. Select **Properties** +3. Adjust the Runtime Identifier + + +Without Visual Studio: + +1. **Edit** the .csproj file +2. **Update the RuntimeIdentifier**: ```xml diff --git a/docs/Using/Package-Building.md b/docs/Using/Package-Building.md index fc21f75..110c850 100644 --- a/docs/Using/Package-Building.md +++ b/docs/Using/Package-Building.md @@ -9,13 +9,6 @@ The publishing process differs slightly between ASP.NET and console applications - **ASP.NET Apps** - Use folder publishing with SelfContained=true - **Console Apps** - Use folder publishing with SelfContained=false -## 📋 Prerequisites - -Before publishing, ensure you have: - -- **Node.js 22.x** installed -- **RuntimeIdentifier** set correctly for your target platform -- **Project configured** for Release builds ## 🚀 Publishing Process @@ -126,7 +119,7 @@ The publish process will: > [!NOTE] > When running publish for a Linux configuration on Windows, Electron.NET will automatically use WSL for the platform-specific steps. -**After publishing**, build the final package, the final results will be in +**After publishing**, the final results will be in `publish\Release\netx.0\xxx-xxx\` diff --git a/src/ElectronNET.WebApp/Views/About/Index.cshtml b/src/ElectronNET.WebApp/Views/About/Index.cshtml index 5d63504..e0175e3 100644 --- a/src/ElectronNET.WebApp/Views/About/Index.cshtml +++ b/src/ElectronNET.WebApp/Views/About/Index.cshtml @@ -10,7 +10,7 @@
Use the demo snippets in an Electron app of your own. The Electron Quick Start(opens in new window) app is a bare-bones setup that pairs with these demos. Follow the instructions here to get it going. To activate Electron.NET include the ElectronNET.API NuGet package in your ASP.NET Core app.
- PM> Install-Package ElectronNET.API
+ dotnet add package ElectronNET.API