You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-50Lines changed: 4 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
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.
10
10
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)
12
12
13
13
14
14
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.
85
85
86
86
## 📔 Usage of the Electron API
87
87
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.
90
89
91
90
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)
92
91
92
+
> [!NOTE]
93
+
> The video hasn't been updated for the changes in ElectronNET.Core, so it is partially outdated.
93
94
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.
97
95
98
96
99
97
## 👨💻 Authors
@@ -110,15 +108,6 @@ See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/
110
108
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).
111
109
Please make sure all commits are properly documented.
112
110
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).
122
111
123
112
## 🙏 Donate
124
113
@@ -141,38 +130,3 @@ MIT-licensed. See [LICENSE](./LICENSE) for details.
141
130
142
131
143
132
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:
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).
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
+
9
15
10
16
## 🙋♀️🙋♂ Contributing
11
17
@@ -40,17 +46,6 @@ Any support appreciated! 🍻
40
46
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
41
47
42
48
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
-
54
49
## 🎉 License
55
50
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.
Copy file name to clipboardExpand all lines: docs/Using/Configuration.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,6 +70,21 @@ Since electron builder still expects a `package.json` file to exist, ElectronNET
70
70
}
71
71
```
72
72
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:
Copy file name to clipboardExpand all lines: docs/Using/Package-Building.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,6 +131,12 @@ The publish process will:
131
131
`publish\Release\netx.0\xxx-xxx\`
132
132
133
133
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
+
134
140
## 🚀 Next Steps
135
141
136
142
-**[Startup Methods](Startup-Methods.md)** - Understanding different launch modes for packaged apps
0 commit comments