mirror of
https://github.com/ElectronNET/Electron.NET.git
synced 2026-07-08 17:56:51 +00:00
Some more polishing
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]
|
||||
|
||||
20
docs/Home.md
20
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).
|
||||
|
||||
@@ -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
|
||||
<!-- For Windows debugging -->
|
||||
|
||||
@@ -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\`
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<p>Use the demo snippets in an Electron app of your own. The <a href="https://github.com/electron/electron-quick-start">Electron Quick Start<span class="u-visible-to-screen-reader">(opens in new window)</span></a> 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 <a href="https://www.nuget.org/packages/ElectronNET.API/" target="_blank">ElectronNET.API NuGet package</a> in your ASP.NET Core app.
|
||||
<p>
|
||||
<code class="language-bash">PM> Install-Package ElectronNET.API</code>
|
||||
<code class="language-bash">dotnet add package ElectronNET.API</code>
|
||||
</p>
|
||||
|
||||
Then include the UseElectron WebHostBuilder-Extension into the Program.cs-file of your ASP.NET Core project.
|
||||
|
||||
Reference in New Issue
Block a user