From c6fa55dd7c5fa3079e2b821eed5d876954ecd956 Mon Sep 17 00:00:00 2001 From: Yuya Ochiai Date: Mon, 5 Dec 2016 23:45:35 +0900 Subject: [PATCH 1/5] Add simple README for Linux packages --- package.json | 2 +- resources/linux/README.md | 74 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 resources/linux/README.md diff --git a/package.json b/package.json index 5206979b..1986fa08 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,7 @@ }, { "from": "resources/linux", - "filter": "create_desktop_file.sh" + "filter": ["create_desktop_file.sh", "README.md"] } ] }, diff --git a/resources/linux/README.md b/resources/linux/README.md new file mode 100644 index 00000000..4944e86a --- /dev/null +++ b/resources/linux/README.md @@ -0,0 +1,74 @@ +# Mattermost Desktop for Linux + +## Table of Contents + +- [Install](#install) +- [Usage](#usage) +- [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-`). + + +### Desktop launcher + +Execute the script file to create `Mattermost.desktop` file. + +``` +/opt/mattermost-desktop-/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. + +``` +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`. + +```sh +# assuming that /opt/mattermost-desktop-/mattermost-desktop is the executable file. +export PATH=$PATH:/opt/mattermost-desktop- +``` + +Alternatively, you can also create a symbolic link for the application. + +```sh +sudo ln -s /opt/mattermost-desktop-/mattermost-desktop /usr/local/bin/ +``` + +## Usage + +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. +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). + + +## Contributing + +See [the contribute file](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md). + + +## License + +Apache Lisence, Version 2.0 From cad3cb5553ea575ff6508ee2532e971d5c066967 Mon Sep 17 00:00:00 2001 From: Jason Blais Date: Tue, 6 Dec 2016 12:53:47 -0500 Subject: [PATCH 2/5] Update README.md --- resources/linux/README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/resources/linux/README.md b/resources/linux/README.md index 4944e86a..678194c9 100644 --- a/resources/linux/README.md +++ b/resources/linux/README.md @@ -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-`). +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-`) 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-/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-/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-/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 From 39117f9208742a8f1465d332d7b308bb41ebecd4 Mon Sep 17 00:00:00 2001 From: Yuya Ochiai Date: Wed, 7 Dec 2016 20:25:30 +0900 Subject: [PATCH 3/5] Update README.md --- resources/linux/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/resources/linux/README.md b/resources/linux/README.md index 678194c9..303b2686 100644 --- a/resources/linux/README.md +++ b/resources/linux/README.md @@ -54,6 +54,7 @@ After launching, you need to configure the application to interact with your tea 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**. +5. Click **Save**. More guides are available at [Mattermost Documentation](https://docs.mattermost.com/help/apps/desktop-guide.html). From 1f71df3b7737fe1c9a0cda66bbbe0534b6e5a007 Mon Sep 17 00:00:00 2001 From: Jason Blais Date: Wed, 7 Dec 2016 08:07:52 -0500 Subject: [PATCH 4/5] Fix typo --- resources/linux/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/linux/README.md b/resources/linux/README.md index 303b2686..0c394f08 100644 --- a/resources/linux/README.md +++ b/resources/linux/README.md @@ -61,7 +61,7 @@ More guides are available at [Mattermost Documentation](https://docs.mattermost. ## Contributing -See [contributing guidlines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md) for reporting bugs, features or submitting pull requests. +See [contributing guidelines](https://github.com/mattermost/desktop/blob/master/CONTRIBUTING.md) for reporting bugs, features or submitting pull requests. ## License From 3bfd688d12828b27030354774a97585ed05e393e Mon Sep 17 00:00:00 2001 From: Yuya Ochiai Date: Thu, 8 Dec 2016 00:10:29 +0900 Subject: [PATCH 5/5] Fix typo --- resources/linux/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/linux/README.md b/resources/linux/README.md index 0c394f08..3f4d42f0 100644 --- a/resources/linux/README.md +++ b/resources/linux/README.md @@ -66,4 +66,4 @@ See [contributing guidelines](https://github.com/mattermost/desktop/blob/master/ ## License -Apache Lisence, Version 2.0 +Apache License, Version 2.0