Skip to content

Commit 117fd6e

Browse files
Merge pull request #192 from ElectronNET/Fix-Readme-After-GlobalTools
Fix readme after Global Tool usage
2 parents dc3eec3 + f5434a0 commit 117fd6e

File tree

1 file changed

+31
-24
lines changed

1 file changed

+31
-24
lines changed

README.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -88,37 +88,21 @@ To start the application make sure you have installed the "[ElectronNET.CLI](htt
8888

8989
dotnet tool install ElectronNET.CLI -g
9090

91-
### ElectronNET.CLI Version 0.0.9
92-
93-
In the Version 0.0.9 the CLI was not a global tool and needed to be registred like this in the .csproj:
94-
95-
```
96-
<ItemGroup>
97-
<DotNetCliToolReference Include="ElectronNET.CLI" Version="0.0.9" />
98-
</ItemGroup>
99-
```
100-
101-
After you edited the .csproj-file, you need to restore your NuGet packages within your Project. Run the follwoing command in your ASP.NET Core folder:
102-
103-
```
104-
dotnet restore
105-
```
106-
10791
* Make sure you have __node.js v8.6.0__ and on __macOS/Linux__ the electron-packager installed!
10892

10993
sudo npm install electron-packager --global
11094

11195
At the first time, you need an Electron.NET project initialization. Type the following command in your ASP.NET Core folder:
11296

11397
```
114-
dotnet electronize init
98+
electronize init
11599
```
116100

117101
* Now a electronnet.manifest.json should appear in your ASP.NET Core project
118102
* Now run the following:
119103

120104
```
121-
dotnet electronize start
105+
electronize start
122106
```
123107
### Note
124108
> Only the first electronize start is slow. The next will go on faster.
@@ -136,26 +120,26 @@ In this YouTube video, we show you how you can create a new project, use the Ele
136120

137121
## Build
138122

139-
Here you need the Electron.NET CLI too. Type following command in your ASP.NET Core folder:
123+
Here you need the Electron.NET CLI as well. Type the following command in your ASP.NET Core folder:
140124

141125
```
142-
dotnet electronize build /target win
126+
electronize build /target win
143127
```
144128

145129
There are additional platforms available:
146130

147131
```
148-
dotnet electronize build /target win
149-
dotnet electronize build /target osx
150-
dotnet electronize build /target linux
132+
electronize build /target win
133+
electronize build /target osx
134+
electronize build /target linux
151135
```
152136

153137
Those three "default" targets will produce x64 packages for those platforms.
154138

155139
For certain NuGet packages or certain scenarios you may want to build a pure x86 application. To support those things you can define the desired [.NET Core runtime](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog), the [electron platform](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#platform) and [electron architecture](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#arch) like this:
156140

157141
```
158-
dotnet electronize build build /target custom win7-x86;win32 /electron-arch ia32
142+
electronize build build /target custom win7-x86;win32 /electron-arch ia32
159143
```
160144

161145
The end result should be an electron app under your __/bin/desktop__ folder.
@@ -190,3 +174,26 @@ See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/
190174
MIT-licensed
191175

192176
**Enjoy!**
177+
178+
# Important notes
179+
180+
## ElectronNET.CLI Version 0.0.9
181+
182+
In the Version 0.0.9 the CLI was not a global tool and needed to be registred like this in the .csproj:
183+
184+
```
185+
<ItemGroup>
186+
<DotNetCliToolReference Include="ElectronNET.CLI" Version="0.0.9" />
187+
</ItemGroup>
188+
```
189+
190+
After you edited the .csproj-file, you need to restore your NuGet packages within your Project. Run the follwoing command in your ASP.NET Core folder:
191+
192+
```
193+
dotnet restore
194+
```
195+
196+
197+
If you still use this version you will need to invoke it like this:
198+
199+
dotnet electronize ...

0 commit comments

Comments
 (0)