README: further cleanups after rename of utils -> sdk (#665)
This commit is contained in:
parent
87437410fc
commit
e70ea1285e
20
README.md
20
README.md
|
@ -64,7 +64,6 @@ Install Node.js 16 first (or if you use [nvm](https://github.com/nvm-sh/nvm), sw
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --global --production windows-build-tools
|
npm install --global --production windows-build-tools
|
||||||
npm config set msvs_version 2017
|
|
||||||
```
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
@ -105,34 +104,33 @@ or from the application `--show-dev-tools` command line flag.
|
||||||
npm run dist
|
npm run dist
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Working with jitsi-meet-electron-utils
|
#### Working with jitsi-meet-electron-sdk
|
||||||
|
|
||||||
[jitsi-meet-electron-utils] is a helper package which implements many features
|
[jitsi-meet-electron-sdk] is a helper package which implements many features
|
||||||
such as remote control and the always-on-top window. If new features are to be
|
such as remote control and the always-on-top window. If new features are to be
|
||||||
added / tested, running with a local version of these utils is very handy, here
|
added / tested, running with a local version of these utils is very handy, here
|
||||||
is how to do that.
|
is how to do that.
|
||||||
|
|
||||||
By default the jitsi-meet-electron-utils is build from its git repository
|
By default the @jitsi/electron-sdk is build from npm. The default dependency path in package.json is:
|
||||||
sources. The default dependency path in package.json is:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"jitsi-meet-electron-utils": "jitsi/jitsi-meet-electron-utils"
|
"@jitsi/electron-sdk": "^3.0.0"
|
||||||
```
|
```
|
||||||
|
|
||||||
To work with local copy you must change the path to:
|
To work with local copy you must change the path to:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"jitsi-meet-electron-utils": "file:///Users/name/jitsi-meet-electron-utils-copy",
|
"@jitsi/electron-sdk": "file:///Users/name/jitsi-meet-electron-sdk-copy",
|
||||||
```
|
```
|
||||||
|
|
||||||
To build the project you must force it to take the sources as `npm update` will
|
To build the project you must force it to take the sources as `npm update` will
|
||||||
not do it.
|
not do it.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install jitsi-meet-electron-utils --force
|
npm install @jitsi/electron-sdk --force
|
||||||
```
|
```
|
||||||
|
|
||||||
NOTE: Also check the [jitsi-meet-electron-utils README] to see how to configure
|
NOTE: Also check the [jitsi-meet-electron-sdk README] to see how to configure
|
||||||
your environment.
|
your environment.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
@ -190,7 +188,7 @@ please join [community forum].
|
||||||
[Jitsi Meet]: https://github.com/jitsi/jitsi-meet
|
[Jitsi Meet]: https://github.com/jitsi/jitsi-meet
|
||||||
[Electron]: https://electronjs.org/
|
[Electron]: https://electronjs.org/
|
||||||
[latest release]: https://github.com/jitsi/jitsi-meet-electron/releases/latest
|
[latest release]: https://github.com/jitsi/jitsi-meet-electron/releases/latest
|
||||||
[jitsi-meet-electron-utils]: https://github.com/jitsi/jitsi-meet-electron-utils
|
[jitsi-meet-electron-sdk]: https://github.com/jitsi/jitsi-meet-electron-sdk
|
||||||
[jitsi-meet-electron-utils README]: https://github.com/jitsi/jitsi-meet-electron-utils/blob/master/README.md
|
[jitsi-meet-electron-sdk README]: https://github.com/jitsi/jitsi-meet-electron-sdk/blob/master/README.md
|
||||||
[community forum]: https://community.jitsi.org/
|
[community forum]: https://community.jitsi.org/
|
||||||
[LICENSE]: LICENSE
|
[LICENSE]: LICENSE
|
||||||
|
|
Loading…
Reference in New Issue