Merge pull request #6 from it33/master

Propose adding step-by-step install guide
This commit is contained in:
Yuya Ochiai 2015-12-31 13:34:55 +09:00
commit 718d425993
2 changed files with 26 additions and 1 deletions

View file

@ -25,7 +25,7 @@ You don't have to install any other software.
### Installation
1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases).
2. Launch `electron-mattermost` in the unarchived folder.
3. After first launching, please input URL for your Mattermost team. For exmaple, `http://mattermost.example.com/team`.
3. After first launching, please input URL for your Mattermost team. For example, `http://mattermost.example.com/team`.
### Quit
Ctrl or Command + Q to quit.

25
docs/setup.md Normal file
View file

@ -0,0 +1,25 @@
# Electron Mattermost Setup Guides
## Step-by-step Windows 7 setup
1. Download [the latest release](https://github.com/yuya-oc/electron-mattermost/releases) of electron Mattermost
Find the file ending in `-win64.zip` if you're running a x64 version of Windows and `-win32.zip` if you're running an older 32-bit version.
2. From the `/Downloads` directory right click on the file and select "Extract All..."
A new directory should be created on your PC.
3. Go to `/electron-mattermost...` directory and double-click on `electron-mattermost` file to start the application
You should see a new application called **electron-mattermost** open.
4. Click `Alt` to bring up the menu at the top of the screen, then click `Settings`
5. For each Mattermost team you'd like to use, enter its **Name** and **URL** then click **Add**
6. Click **Save** to save your setting
You're now ready to use Electron Mattermost to interact with multiple teams from one desktop application
To quit, use `Ctrl+Q`