aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Jason Blais 2016-12-06 12:53:47 -05:00 committed by GitHub
parent c6fa55dd7c
commit cad3cb5553
1 changed files with 13 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
resources/linux/README.md
View file

@ -3,31 +3,26 @@
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [User Guide](#user-guide)
- [Contributing](#contributing)
- [License](#license)
## Install
If you were installed the application via package managers, you don't have to do
anymore. It's ready to use in your system, so please follow [usage](#usage)
instruction.
First, locate the extracted directory into your desired directory (e.g.
`/opt/mattermost-desktop-<VERSION>`).
If you installed the application via a package manager, it's ready to use in your system. Please follow the [User Guide](#user-guide) for further information.
Otherwise, first locate the extracted directory in your desired directory (e.g. `/opt/mattermost-desktop-<VERSION>`) and follow the steps below.
### Desktop launcher
Execute the script file to create `Mattermost.desktop` file.
Execute the script file to create a `Mattermost.desktop` file.
```
/opt/mattermost-desktop-<VERSION>/create_desktop_file.sh
```
Then move it into appropreate directory of your desktop environment. For
example, it's `~/.local/share/applications/` for current user on Ubuntu Unity.
Then move it to the appropriate directory of your desktop environment. For example, on Ubuntu Unity it's `~/.local/share/applications/` for the current user.
```
mv Mattermost.desktop ~/.local/share/applications/
@ -35,8 +30,7 @@ mv Mattermost.desktop ~/.local/share/applications/
### Terminal command
Set `PATH` environment variable to enable launching from terminal.
For example, you can append following line into `~/.bashrc`.
Set a `PATH` environment variable to enable launching from the terminal. For example, you can append the following line into `~/.bashrc`.
```sh
# assuming that /opt/mattermost-desktop-<VERSION>/mattermost-desktop is the executable file.
@ -49,24 +43,24 @@ Alternatively, you can also create a symbolic link for the application.
sudo ln -s /opt/mattermost-desktop-<VERSION>/mattermost-desktop /usr/local/bin/
```
## Usage
You're now all set! See the [User Guide](#user-guide) below for instructions.
## User Guide
After launching, you need to configure the application to interact with your team.
1. If you don't see "Settings" page, select **File** -> **Settings...** from the menu bar.
1. If you don't see a page titled "Settings", select **File** > **Settings...** from the menu bar.
2. Click **Add new team** next to the right of Team Management section.
3. Enter **Name** and a valid **URL**, which begins with either `http://` or `https://`.
4. Click **Add**.
### More guides
Available at [Mattermost Documentation](https://docs.mattermost.com/help/apps/desktop-guide.html).
More guides are available at [Mattermost Documentation](https://docs.mattermost.com/help/apps/desktop-guide.html).
## Contributing
See [the contribute file](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md).
See [contributing guidlines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md) for reporting bugs, features or submitting pull requests.
## License