Skip to content

Commit 2bc2b4b

Browse files
committed
Move some parts from ReadMe to Wiki
1 parent 771b110 commit 2bc2b4b

File tree

5 files changed

+49
-65
lines changed

5 files changed

+49
-65
lines changed

README.md

Lines changed: 4 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
ElectronNET.Core represents a fundamental modernization of Electron.NET, addressing years of accumulated pain points while preserving full API compatibility. This isn't just an update—it's a complete rethinking of how .NET developers build and debug cross-platform desktop applications with Electron.
1010

11-
Read more: [**What's New in ElectronNET.Core**](WHATS_NEW.md)
11+
Read more: [**What's New in ElectronNET.Core**](wiki/What's-New)
1212

1313

1414
Build cross platform desktop applications with .NET 6/8 - from console apps to ASP.Net Core (Razor Pages, MVC) to Blazor
@@ -85,15 +85,13 @@ Just press F5 in Visual Studio or use dotnet for debugging.
8585

8686
## 📔 Usage of the Electron API
8787

88-
A complete documentation will follow. Until then take a look in the source code of the sample application:
89-
[Electron.NET API Demos](https://github.com/ElectronNET/electron.net-api-demos)
88+
A complete documentation is available on the Wiki.
9089

9190
In this YouTube video, we show you how you can create a new project, use the Electron.NET API, debug a application and build an executable desktop app for Windows: [Electron.NET - Getting Started](https://www.youtube.com/watch?v=nuM6AojRFHk)
9291

92+
> [!NOTE]
93+
> The video hasn't been updated for the changes in ElectronNET.Core, so it is partially outdated.
9394
94-
### Note
95-
96-
> macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per [this Electron issue](https://github.com/electron-userland/electron-packager/issues/71)). macOS builds can be produced on either Linux or macOS machines.
9795

9896

9997
## 👨‍💻 Authors
@@ -110,15 +108,6 @@ See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/
110108
Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues).
111109
Please make sure all commits are properly documented.
112110

113-
## 🧪 Working with this Repo
114-
115-
This video provides an introduction to development for Electron.NET: [Electron.NET - Contributing Getting Started](https://youtu.be/Po-saU_Z6Ws)
116-
117-
This repository consists of the main parts (API & CLI) and it's own "playground" ASP.NET Core application. Both main parts produce local NuGet packages, that are versioned with 99.0.0. The first thing you will need is to run one of the build scripts (.cmd or .ps1 for Windows, the .sh for macOS/Linux).
118-
119-
If you look for pure __[demo projects](https://github.com/ElectronNET)__ checkout the other repositories.
120-
121-
The problem working with this repository is, that NuGet has a pretty aggressive cache, see [here for further information](https://github.com/ElectronNET/Electron.NET/wiki).
122111

123112
## 🙏 Donate
124113

@@ -141,38 +130,3 @@ MIT-licensed. See [LICENSE](./LICENSE) for details.
141130

142131

143132

144-
### Node.js Integration
145-
146-
Electron.NET requires Node.js integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node.js integration like so:
147-
148-
```csharp
149-
WebPreferences wp = new WebPreferences();
150-
wp.NodeIntegration = false;
151-
BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions
152-
{
153-
WebPreferences = wp
154-
};
155-
156-
```
157-
158-
### Dependency Injection
159-
160-
ElectronNET.API can be added to your DI container within the `Startup` class. All of the modules available in Electron will be added as Singletons.
161-
162-
```csharp
163-
using ElectronNET.API;
164-
165-
public void ConfigureServices(IServiceCollection services)
166-
{
167-
services.AddElectron();
168-
}
169-
```
170-
171-
## 💬 Community
172-
173-
[![Gitter](https://badges.gitter.im/ElectronNET/community.svg)](https://gitter.im/ElectronNET/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
174-
175-
Besides the chat on Gitter and the issues [discussed here](https://github.com/ElectronNET/Electron.NET/issues) you can also use [StackOverflow](https://stackoverflow.com/questions/tagged/electron.net) with the tag `electron.net`.
176-
177-
If you want to sponsor the further maintenance and development of this project [see the donate section](#🙏-donate).
178-

docs/About.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Electron.NET has been developed by a small number of people in the hope that it
66

77
Support for this project in all forms is very welcome, no matter whether in form of code contributions or donations.
88

9+
## 💬 Community
10+
11+
[![Gitter](https://badges.gitter.im/ElectronNET/community.svg)](https://gitter.im/ElectronNET/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
12+
13+
Besides the chat on Gitter and the issues [discussed here](https://github.com/ElectronNET/Electron.NET/issues) you can also use [StackOverflow](https://stackoverflow.com/questions/tagged/electron.net) with the tag `electron.net`.
14+
915

1016
## 🙋‍♀️🙋‍♂ Contributing
1117

@@ -40,17 +46,6 @@ Any support appreciated! 🍻
4046
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
4147

4248

43-
## 🧪 Working with this Repo
44-
45-
This video provides an introduction to development for Electron.NET: [Electron.NET - Contributing Getting Started](https://youtu.be/Po-saU_Z6Ws)
46-
47-
This repository consists of the main parts (API & CLI) and it's own "playground" ASP.NET Core application. Both main parts produce local NuGet packages, that are versioned with 99.0.0. The first thing you will need is to run one of the build scripts (.cmd or .ps1 for Windows, the .sh for macOS/Linux).
48-
49-
If you look for pure __[demo projects](https://github.com/ElectronNET)__ checkout the other repositories.
50-
51-
The problem working with this repository is, that NuGet has a pretty aggressive cache, see [here for further information](https://github.com/ElectronNET/Electron.NET/wiki).
52-
53-
5449
## 🎉 License
5550

56-
MIT-licensed. See [LICENSE](./LICENSE) for details.
51+
MIT-licensed. See [LICENSE](https://github.com/ElectronNET/Electron.NET?tab=MIT-1-ov-file#readme) for details.

docs/GettingStarted/ASP.Net.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,25 @@ If you want to launch a specific URL, you can retrieve the actual ASP.NET port f
9090
For projects using the traditional `Startup.cs` pattern, please see "Traditional ASP.NET Core" in the [Migration Guide](../Core/Migration-Guide.md).
9191

9292

93+
### 5. Dependency Injection
94+
95+
ElectronNET.API can be added to your DI container within the `Startup` class. All of the modules available in Electron will be added as Singletons.
96+
97+
```csharp
98+
using ElectronNET.API;
99+
100+
public void ConfigureServices(IServiceCollection services)
101+
{
102+
services.AddElectron();
103+
}
104+
```
105+
106+
93107
## 🚀 Next Steps
94108

95-
- **[Debugging](Debugging.md)** - Learn about ASP.NET debugging features
96-
- **[Package Building](Package-Building.md)** - Create distributable packages
97-
- **[Startup Methods](Startup-Methods.md)** - Understanding launch scenarios
109+
- **[Debugging](../Using/Debugging.md)** - Learn about ASP.NET debugging features
110+
- **[Package Building](../Using/Package-Building.md)** - Create distributable packages
111+
- **[Startup Methods](../Using/Startup-Methods.md)** - Understanding launch scenarios
98112

99113
## 💡 Benefits of ASP.NET + Electron
100114

docs/Using/Configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,21 @@ Since electron builder still expects a `package.json` file to exist, ElectronNET
7070
}
7171
```
7272

73+
### Node.js Integration
74+
75+
Electron.NET requires Node.js integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node.js integration like so:
76+
77+
```csharp
78+
WebPreferences wp = new WebPreferences();
79+
wp.NodeIntegration = false;
80+
BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions
81+
{
82+
WebPreferences = wp
83+
};
84+
85+
```
86+
87+
7388

7489
## 🚀 Next Steps
7590

docs/Using/Package-Building.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,12 @@ The publish process will:
131131
`publish\Release\netx.0\xxx-xxx\`
132132

133133

134+
## MacOS
135+
136+
> [!NOTE]
137+
> macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per [this Electron issue](https://github.com/electron-userland/electron-packager/issues/71)). macOS builds can be produced on either Linux or macOS machines.
138+
139+
134140
## 🚀 Next Steps
135141

136142
- **[Startup Methods](Startup-Methods.md)** - Understanding different launch modes for packaged apps

0 commit comments

Comments
 (0)