diff --git a/README.md b/README.md index 96b5347..bb69bb9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ +
-
- Permanent account storage @@ -27,17 +27,7 @@ It should happen once. A very basic integration of [Converse.js](https://convers - All the best from Converse.js like system notifications, MAM, OMEMO etc. See details at [Converse.js](https://conversejs.org/) -#### License information - -Like Converse.js, Converse Desktop's files are released under the Mozilla Public License version 2 (MPLv2). The gist of this license is that the covered files must stay open source, and modifications to them need to be released under the same license, but new files (for example for your own plugin) don't have to be released under the same license. - -However, libsignal library, which is required for OMEMO support is released under the GPLv3. The MPLv2 license is compatible with GPLv3 and when GPLv3 code is included, the entire project effectively is licensed under the GPLv3. - -Any custom build of Converse Desktop without libsignal included will again be licensed -under the MPLv2. - - -#### Changelog +## Changelog See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHANGES.md) @@ -53,27 +43,22 @@ See [CHANGES.md](https://github.com/conversejs/converse-desktop/blob/master/CHAN - [All releases](https://github.com/conversejs/converse-desktop/releases) -#### Run with npm +## Build from source -``` +```bash git clone https://github.com/conversejs/converse-desktop.git cd converse-desktop npm i $(npm bin)/electron-rebuild +``` + +Then, to run: + +```bash npm start ``` -### Development - -Prepare -``` -git clone https://github.com/conversejs/converse-desktop.git -cd converse-desktop -npm i -$(npm bin)/electron-rebuild -``` - -Build targets +### Build targets: | Operation System | Target | -------------------|---------------- @@ -82,3 +67,22 @@ Build targets | Linux DEB | `npm run dist:linux64deb` | More targets could be added via `package.json`. See [electron builder docs](https://www.electron.build/configuration/configuration). + + +## License + +Like Converse.js, Converse Desktop's files are released under the Mozilla Public License version 2 (MPLv2). The gist of this license is that the covered files must stay open source, and modifications to them need to be released under the same license, but new files (for example for your own plugin) don't have to be released under the same license. + +However, libsignal library, which is required for OMEMO support is released under the GPLv3. The MPLv2 license is compatible with GPLv3 and when GPLv3 code is included, the entire project effectively is licensed under the GPLv3. + +Any custom build of Converse Desktop without libsignal included will again be licensed +under the MPLv2. + + +## Acknowledgements + +This project started as a fork of Nick Denry's [Chimeverse](https://github.com/conversejs/converse-desktop). + + + +