[MM-40632] Updates to the Developer Documentation and README, remove unnecessary files and code (#1922)
* [MM-40632] Updates to the Developer Documentation and README, remove unnecessary files and code * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update README.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update README.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Guillermo Vayá <guivaya@gmail.com> * Update TESTING.md Co-authored-by: Guillermo Vayá <guivaya@gmail.com> * PR feedback Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Guillermo Vayá <guivaya@gmail.com>
This commit is contained in:
Devin Binnie
52
README.md
52
README.md
@@ -1,40 +1,32 @@
|
||||
# Mattermost Desktop
|
||||
|
||||
Native desktop application for [Mattermost](http://www.mattermost.org/) running on Windows, Mac, and Linux.
|
||||
[Mattermost](https://mattermost.com) is an open source platform for secure collaboration across the entire software development lifecycle. This repo is for the native desktop application that's built on [Electron](http://electron.atom.io/); it runs on Windows, Mac, and Linux.
|
||||
|
||||
Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Electron](http://electron.atom.io/).
|
||||
Originally created as "electron-mattermost" by Yuya Ochiai.
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://circleci.com/gh/mattermost/desktop)
|
||||
|
||||
## Features
|
||||
|
||||
### Desktop integration
|
||||
* Tabs for multiple teams across multiple servers
|
||||
* Server dropdown for access to multiple teams
|
||||
* Dedicated tabs for Channels, Boards and Playbooks
|
||||
* Desktop Notifications
|
||||
* Windows 10: Toast
|
||||
* Windows 7-8.1: Popup like Toast
|
||||
* OS X: Notification Center
|
||||
* Linux: [libnotify](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux)
|
||||
* Badges for unread channels and mentions
|
||||
* Installs as a native application
|
||||
|
||||
### Pre-packaged
|
||||
You don't have to install any other software.
|
||||
Packages are available on the [releases page](http://github.com/mattermost/desktop/releases).
|
||||
* Deep Linking to open Mattermost links directly in the app
|
||||
* Runs in background to reduce number of open windows
|
||||
|
||||
## Usage
|
||||
|
||||
### Installation
|
||||
Detailed guides are available at [docs.mattermost.com](https://about.mattermost.com/default-desktop-app-documentation/).
|
||||
Detailed guides are available at [docs.mattermost.com](https://docs.mattermost.com/install/desktop-app-install.html).
|
||||
|
||||
1. Download a file from the [downloads page](https://about.mattermost.com/downloads).
|
||||
2. Launch `Mattermost` in the unarchived folder.
|
||||
3. On the first launch, please input name and URL for your Mattermost server. For example, `myserver : https://mattermost.example.com`.
|
||||
|
||||
### Quit
|
||||
Ctrl or Command + Q to quit.
|
||||
1. Download a file from the [downloads page](https://mattermost.com/download/#mattermostApps) or from the [releases page](https://github.com/mattermost/desktop/releases).
|
||||
2. Run the installer or unzip the archive.
|
||||
3. Launch Mattermost from your Applications folder, menu, or the unarchived folder.
|
||||
3. On the first launch, please enter a name and URL for your Mattermost server. For example, `https://mattermost.example.com`.
|
||||
|
||||
### Configuration
|
||||
You can show the dialog from menu bar.
|
||||
@@ -51,24 +43,8 @@ A custom data directory location can be specified with:
|
||||
* `open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/` on macOS
|
||||
* `./mattermost-desktop --args --data-dir ~/my-mattermost-data/` on Linux
|
||||
|
||||
*When you upgrade from electron-mattermost, please copy `config.json` from `electron-mattermost`.
|
||||
Otherwise, you have to configure again.*
|
||||
|
||||
### Proxy
|
||||
Normally, the application will follow your system settings to use a proxy, or you can set up a proxy by the following command line options.
|
||||
|
||||
* `--proxy-server=<SERVER>:<PORT>`
|
||||
* `--proxy-pac-url=<URL>`
|
||||
|
||||
On Windows, please make sure to add `--` before options. For example, `Mattermost.exe -- --proxy-server=...`.
|
||||
|
||||
## Custom App Deployments
|
||||
Our [docs provide a guide](https://docs.mattermost.com/deployment/desktop-app-deployment.html) on how to customize and distribute your own Mattermost Desktop App, including how to distribute the official Windows Desktop App silently to end users, pre-configured with the server URL and other app settings.
|
||||
|
||||
## Contributing
|
||||
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).
|
||||
|
||||
## Development
|
||||
Please see [docs/development.md](./docs/development.md).
|
||||
|
||||
|
||||
## Development and Making Contributions
|
||||
Our [developer guide](https://developers.mattermost.com/contribute/desktop/) has detailed information on how to set up your development environment, develop, and test changes to the Desktop App.
|
||||
|
||||
Reference in New Issue
Block a user