Skip to content

Commit be1887c

Browse files
FlorianRapplFlorianRappl
authored
Merge pull request #895 from softworkz/electronnet_core
Add documentation
2 parents 82814d9 + 1852802 commit be1887c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+13368
-59
lines changed

‎.github/WikiLinks.exe‎

1.83 MB
Binary file not shown.

‎.github/workflows/publish-wiki.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Publish wiki
2+
on:
3+
push:
4+
branches: [electronnet_core, main]
5+
workflow_dispatch:
6+
concurrency:
7+
group: publish-wiki
8+
cancel-in-progress: true
9+
permissions:
10+
contents: write
11+
jobs:
12+
publish-wiki:
13+
runs-on: windows-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Remove level 1 headings from Markdown files
17+
shell: bash
18+
run: |
19+
find docs/ -name '*.md' -exec sed -i '1d' {} \;
20+
- name: Move all files to root folder
21+
shell: bash
22+
run: |
23+
mv docs/*/* docs/
24+
- name: Delete unwanted files
25+
shell: bash
26+
run: |
27+
# rm docs/*.xlsm
28+
# rm docs/*.pptx
29+
rm docs/*.shproj
30+
- name: Stripping file extensions....
31+
uses: softworkz/strip-markdown-extensions-from-links-action@main
32+
with:
33+
path: ./docs/
34+
- name: Copy Changelog
35+
shell: bash
36+
run: |
37+
cp Changelog.md docs/RelInfo/ 2>/dev/null || true
38+
- name: Copy images to wiki/wiki folder
39+
shell: bash
40+
run: |
41+
mkdir docs/wiki
42+
cp docs/*.svg docs/wiki/ 2>/dev/null || true
43+
cp docs/*.png docs/wiki/ 2>/dev/null || true
44+
cp docs/*.jpg docs/wiki/ 2>/dev/null || true
45+
cp docs/*.gif docs/wiki/ 2>/dev/null || true
46+
cp docs/*.mp4 docs/wiki/ 2>/dev/null || true
47+
- name: Commit and push changes
48+
run: |
49+
git config --global user.name "GitHub Action"
50+
git config --global user.email "[email protected]"
51+
git add -A
52+
git commit -m "Automatically update Markdown files" || echo "No changes to commit"
53+
- uses: Andrew-Chen-Wang/[email protected]
54+
with:
55+
path: docs/
56+
ignore: |
57+
'**/*.xlsm'
58+
'**/*.pptx'
59+
'**/*.shproj'

‎README.md‎

Lines changed: 6 additions & 52 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
@@ -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
@@ -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/.docproj/DocProj.props‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
4+
<PropertyGroup>
5+
<TargetPlatformVersion>8.1</TargetPlatformVersion>
6+
<IsCodeSharingProject>true</IsCodeSharingProject>
7+
<DefineCommonItemSchemas>true</DefineCommonItemSchemas>
8+
</PropertyGroup>
9+
10+
<PropertyGroup>
11+
<MdIncludes>**/*.md;**/*.markdown</MdIncludes>
12+
<ImageIncludes>**/*.png;**/*.bmp;**/*.jpg;**/*.gif;**/*.mp4</ImageIncludes>
13+
<WebIncludes>**/*.css;**/*.js;**/*.json</WebIncludes>
14+
</PropertyGroup>
15+
16+
<ItemGroup>
17+
<Compile Remove="**/*" />
18+
<Content Remove="**/*" />
19+
</ItemGroup>
20+
21+
<ItemGroup>
22+
<None Include="$(ImageIncludes)" />
23+
<None Include="$(WebIncludes)" />
24+
<None Include="$(MdIncludes)" />
25+
</ItemGroup>
26+
27+
</Project>

‎docs/.docproj/DocProj.targets‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
<ItemGroup>
4+
<ProjectCapability Include="SourceItemsFromImports;SharedImports;SharedAssetsProject"/>
5+
<ProjectCapability Include="HandlesOwnReload"/>
6+
<ProjectCapability Include="UserSourceItems"/>
7+
<ProjectCapability Include="OpenProjectFile"/>
8+
<ProjectCapability Include="UseFileGlobs"/>
9+
<ProjectCapability Include="SingleFileGenerators"/>
10+
</ItemGroup>
11+
12+
<Target Name="Compile">
13+
</Target>
14+
15+
<Target Name="Build">
16+
</Target>
17+
18+
<Target Name="Clean">
19+
</Target>
20+
21+
<Target Name="_CheckForInvalidConfigurationAndPlatform">
22+
</Target>
23+
</Project>

0 commit comments

Comments
 (0)