Updated README

This commit is contained in:
Saúl Ibarra Corretgé 2018-07-19 10:09:40 +02:00
parent 15fc665c92
commit e58a887690
1 changed files with 78 additions and 17 deletions

View File

@ -1,38 +1,99 @@
Jitsi Meet Electron
====
Electron application for [Jitsi Meet](https://github.com/jitsi/jitsi-meet).
# Jitsi Meet Electron
## Configuration
You can change the Jitsi Meet deployment domain with the jitsiMeetDomain property from config.js
Desktop application for [Jitsi Meet] built with [Electron].
## Features
- Works with any Jitsi Meet deployment
- Local settings
- Builtin auto-updates
- Remote control
- Always-On-Top window
## Installation
Grab the [latest release] and you're off to the races! The supported platforms
are macOS, Windows (both 32 and 64bits) and GNU/Linux (64bits only).
NOTE: On old GNU/Linux distributions you might get the following error:
```
FATAL:nss_util.cc(632)] NSS_VersionCheck("3.26") failed. NSS >= 3.26 is required.
Please upgrade to the latest NSS, and if you still get this error, contact your
distribution maintainer.
```
If you do, please install NSS (example for Debian / Ubuntu):
```bash
sudo apt-get install libnss3
```
## Development
If you want to hack on this project, here is how you do it.
#### Building the sources
## Building the sources
```bash
npm install
```
## Working with the [jitsi-meet-electron-utils](https://github.com/jitsi/jitsi-meet-electron-utils) sources
By default the jitsi-meet-electron-utils is build from its git repository sources. The default dependency path in package.json is :
#### Starting in development mode
```bash
npm start
```
#### Building the production distribution
```bash
npm run dist
```
#### Working with jitsi-meet-electron-utils
[jitsi-meet-electron-utils] is a helper package which implements many features
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
is how to do that.
By default the jitsi-meet-electron-utils is build from its git repository
sources. The default dependency path in package.json is:
```json
"jitsi-meet-electron-utils": "jitsi/jitsi-meet-electron-utils"
```
To work with local copy you must change the path to:
```json
"jitsi-meet-electron-utils": "file:///Users/name/jitsi-meet-electron-utils-copy",
```
To make the project you must force it to take the sources as `npm update` will not do it.
To build the project you must force it to take the sources as `npm update` will
not do it.
```bash
npm install jitsi-meet-electron-utils --force
node_modules/.bin/electron-rebuild
```
NOTE: Also check jitsi-meet-electron-utils's [README](https://github.com/jitsi/jitsi-meet-electron-utils/blob/master/README.md) to see how to configure your environment.
NOTE: Also check the [jitsi-meet-electron-utils README] to see how to configure
your environment.
## Statring the application
```bash
npm start
```
## License
## Discuss
Please use the [Jitsi dev mailing list](http://lists.jitsi.org/pipermail/dev/) to discuss feature requests before opening an issue on Github.
Apache 2. See the [LICENSE] file.
## Community
Jitsi is built by a large community of developers, if you want to participate,
please join [community forum].
[Jitsi Meet]: https://github.com/jitsi/jitsi-meet
[Electron]: https://electronjs.org/
[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-utils README]: https://github.com/jitsi/jitsi-meet-electron-utils/blob/master/README.md
[community forum]: https://community.jitsi.org/
[LICENSE]: LICENSE