Skip to content

Commit 2296ff6

Browse files
aso20455Aniket-Engg
authored andcommitted
Update README.md
1 parent 5c80a9d commit 2296ff6

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

apps/remixdesktop/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ const clientProfile: Profile = {
4444

4545
As you can see in the clientProfile you define the methods which are exposed to the Remix plugin system.
4646

47-
5. add a base plugin and a plugin client
47+
4. add a base plugin and a plugin client
4848
```
4949
export class CompilerLoaderPlugin extends ElectronBasePlugin {
5050
clients: CompilerLoaderPluginClient[] = []
@@ -71,7 +71,7 @@ The ElectronBasePluginClient is the specific instance which will be connected to
7171

7272
Any instance specific code is set as functions on the ElectronBasePluginClient class.
7373

74-
6. If you need fs access you need to track the workingdir like we do here:
74+
5. If you need fs access you need to track the workingdir like we do here:
7575
This ensures you know where the user is working
7676

7777
```
@@ -92,7 +92,7 @@ class IsoGitPluginClient extends ElectronBasePluginClient {
9292
9393
```
9494

95-
7. If you need to call methods on the BASE which holds all the clients you can add methods there, for example this iterates over clients
95+
6. If you need to call methods on the BASE which holds all the clients you can add methods there, for example this iterates over clients
9696
and finds the one with the webContentsId. This ID passed on ie by menu items. Look at menu.ts to see how that works.
9797

9898
```
@@ -104,29 +104,29 @@ and finds the one with the webContentsId. This ID passed on ie by menu items. Lo
104104
}
105105
```
106106

107-
8. Add your plugin to engine.ts
107+
7. Add your plugin to engine.ts
108108

109109
```
110110
const compilerLoaderPlugin = new CompilerLoaderPlugin()
111111
```
112112

113-
9. Register the plugin in engine.ts
113+
8. Register the plugin in engine.ts
114114

115115
```
116116
engine.register(compilerLoaderPlugin)
117117
```
118118

119-
10. activation of plugins is done when the clients connect to the engine. No need to activate it.
119+
9. activation of plugins is done when the clients connect to the engine. No need to activate it.
120120

121-
11. Add the plugin to the preload.ts. Add it to this list:
121+
10. Add the plugin to the preload.ts. Add it to this list:
122122

123123
```
124124
const exposedPLugins = ['fs', 'git', 'xterm', 'isogit', 'electronconfig', 'electronTemplates', 'ripgrep', 'compilerloader', 'appUpdater']
125125
```
126126

127127
If you don't do this, it won't work.
128128

129-
12. In Remix IDE create a plugin in src/app/plugins/electron. If everything works correctly the methods will be loaded from the electron side, no need to specify them here.
129+
11. In Remix IDE create a plugin in src/app/plugins/electron. If everything works correctly the methods will be loaded from the electron side, no need to specify them here.
130130
This plugin is only a passthrough.
131131

132132
```
@@ -150,11 +150,10 @@ export class compilerLoaderPluginDesktop extends ElectronPlugin {
150150
}
151151
```
152152

153-
13. if you need to activate that on load you need to add it to the app.js where other plugins are activated.
153+
12. if you need to activate that on load you need to add it to the app.js where other plugins are activated.
154154

155155

156156

157157
## CI
158158

159159
CI will only run the builds if the branch is master or contains the word: desktop
160-

0 commit comments

Comments
 (0)