Skip to content

Commit 1852802

Browse files
committed
Some more polishing
1 parent 5bdabd9 commit 1852802

File tree

8 files changed

+45
-34
lines changed

8 files changed

+45
-34
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Also you should have installed:
4141
- Install the following two nuget packages:
4242

4343
```ps1
44-
PM> Install-Package ElectronNET.Core
44+
dotnet add package ElectronNET.Core
4545
46-
PM> Install-Package ElectronNET.Core.AspNet
46+
dotnet add package ElectronNET.Core.AspNet
4747
```
4848

4949
### Enable Electron.NET on Startup

docs/Core/Migration-Guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Before starting the migration:
1616

1717
**Uninstall old packages:**
1818
```powershell
19-
PM> Uninstall-Package ElectronNET.API
19+
dotnet remove package ElectronNET.API
2020
```
2121

2222
**Install new packages:**
2323
```powershell
24-
PM> Install-Package ElectronNET.Core
25-
PM> Install-Package ElectronNET.Core.AspNet # For ASP.NET projects
24+
dotnet add package ElectronNET.Core
25+
dotnet add package ElectronNET.Core.AspNet # For ASP.NET projects
2626
```
2727

2828
> **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.

docs/GettingStarted/ASP.Net.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ See [System Requirements](../GettingStarted/System-Requirements.md).
1212

1313
### 1. Create ASP.NET Core Project
1414

15-
Create a new ASP.NET Core Web App in Visual Studio:
15+
#### Visual Studio
16+
17+
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.
18+
19+
#### From the command line
1620

1721
```bash
1822
dotnet new webapp -n MyElectronWebApp
@@ -21,14 +25,20 @@ cd MyElectronWebApp
2125

2226
### 2. Install NuGet Packages
2327

28+
#### Visual Studio
29+
30+
Right-click the solution and select **Manage Nuget Packages**.
31+
Finr and install `ElectronNET.Core` as well as `ElectronNET.Core.AspNet`.
32+
33+
#### From the command line
34+
2435
```powershell
25-
PM> Install-Package ElectronNET.Core
26-
PM> Install-Package ElectronNET.Core.AspNet
36+
dotnet add package ElectronNET.Core
37+
dotnet add package ElectronNET.Core.AspNet
2738
```
28-
2939

3040
> [!Note]
31-
> `ElectronNET.Core.AspNet` provides ASP.NET-specific runtime components and should be used alongside `ElectronNET.Core`.
41+
> The API package is automatically included as a dependency of `ElectronNET.Core`.
3242
3343

3444
### 3. Configure Program.cs

docs/GettingStarted/Console-App.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ See [System Requirements](../GettingStarted/System-Requirements.md).
2222

2323
### 1. Create Console Application
2424

25-
Create a new Console Application project in Visual Studio:
25+
#### Visual Studio
26+
27+
Create a new console application in Visual Studio by selecting **New Project** and choosing one of the project templates for console apps.
28+
29+
#### From the command line
2630

2731
```bash
2832
dotnet new console -n MyElectronApp
@@ -32,7 +36,7 @@ cd MyElectronApp
3236
### 2. Install NuGet Packages
3337

3438
```powershell
35-
PM> Install-Package ElectronNET.Core
39+
dotnet add package ElectronNET.Core
3640
```
3741

3842
> [!Note]

docs/Home.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,16 @@ Electron.NET Core is a complete modernization of Electron.NET that eliminates th
3434

3535
## 🛠 System Requirements
3636

37-
- **.NET 8.0** or later
38-
- **Node.js 22.x** or later
39-
- **Visual Studio 2022** (recommended) or other .NET IDE
40-
- **WSL2** (for Linux development on Windows)
37+
See [System Requirements](GettingStarted/System-Requirements.md).
4138

4239
## 💡 Key Benefits
4340

44-
**No CLI Tools Required** - Everything works through Visual Studio
45-
**Console App Support** - Use any HTML/JS source, not just ASP.NET
46-
**True Cross-Platform** - Build Linux apps from Windows
47-
**Modern Debugging** - Hot Reload and ASP.NET-first debugging
48-
**Flexible Packaging** - Choose any Electron version
49-
**MSBuild Integration** - Leverages .NET's build system
41+
**No CLI Tools Required** - Everything works through Visual Studio
42+
**Console App Support** - Use any HTML/JS source, not just ASP.NET
43+
**True Cross-Platform** - Build Linux apps from Windows
44+
**Modern Debugging** - Hot Reload and ASP.NET-first debugging
45+
**Flexible Packaging** - Choose any Electron version
46+
**MSBuild Integration** - Leverages .NET's build system
5047

5148
## 🚦 Getting Started
5249

@@ -58,4 +55,5 @@ New to ElectronNET.Core? Start here:
5855

5956
## 🤝 Contributing
6057

61-
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).
58+
Found an issue or want to improve the documentation? Contributions are welcome!
59+
The wiki is auto-generated from the `/docs` folder in the [GitHub repository](https://github.com/ElectronNET/Electron.NET).

docs/Using/Debugging.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,14 @@ Add the debugging profiles to `Properties/launchSettings.json`:
123123
When switching between Windows and WSL debugging:
124124

125125
1. **Right-click your project** in Solution Explorer
126-
2. **Select "Edit Project File"**
127-
3. **Update the RuntimeIdentifier**:
126+
2. Select **Properties**
127+
3. Adjust the Runtime Identifier
128+
129+
130+
Without Visual Studio:
131+
132+
1. **Edit** the .csproj file
133+
2. **Update the RuntimeIdentifier**:
128134

129135
```xml
130136
<!-- For Windows debugging -->

docs/Using/Package-Building.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,6 @@ The publishing process differs slightly between ASP.NET and console applications
99
- **ASP.NET Apps** - Use folder publishing with SelfContained=true
1010
- **Console Apps** - Use folder publishing with SelfContained=false
1111

12-
## 📋 Prerequisites
13-
14-
Before publishing, ensure you have:
15-
16-
- **Node.js 22.x** installed
17-
- **RuntimeIdentifier** set correctly for your target platform
18-
- **Project configured** for Release builds
1912

2013
## 🚀 Publishing Process
2114

@@ -126,7 +119,7 @@ The publish process will:
126119
> [!NOTE]
127120
> When running publish for a Linux configuration on Windows, Electron.NET will automatically use WSL for the platform-specific steps.
128121
129-
**After publishing**, build the final package, the final results will be in
122+
**After publishing**, the final results will be in
130123

131124
`publish\Release\netx.0\xxx-xxx\`
132125

src/ElectronNET.WebApp/Views/About/Index.cshtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<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.
1111
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.
1212
<p>
13-
<code class="language-bash">PM> Install-Package ElectronNET.API</code>
13+
<code class="language-bash">dotnet add package ElectronNET.API</code>
1414
</p>
1515

1616
Then include the UseElectron WebHostBuilder-Extension into the Program.cs-file of your ASP.NET Core project.

0 commit comments

Comments
 (0)