From 66f75272376204ee33edb19cfb57006cdebad40b Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 14 Aug 2018 14:47:08 -0700 Subject: [PATCH] user docs: Update desktop app install guide. --- .../zerver/help/desktop-app-install-guide.md | 99 +++++++++---------- 1 file changed, 46 insertions(+), 53 deletions(-) diff --git a/templates/zerver/help/desktop-app-install-guide.md b/templates/zerver/help/desktop-app-install-guide.md index e22fe5e005..103ed5f209 100644 --- a/templates/zerver/help/desktop-app-install-guide.md +++ b/templates/zerver/help/desktop-app-install-guide.md @@ -14,29 +14,28 @@ look at the newest features, consider the [beta releases](#beta-releases). ### Disk image (recommended) -1. Download [Zulip-x.x.x.dmg][latest] -2. Open the file, and drag the app into the `Applications` folder -3. Done! -4. The app will update automatically to future versions. +1. Download [Zulip for MacOS](https://zulipchat.com/apps/mac). +1. Open the file, and drag the app into the `Applications` folder. + +The app will update automatically to future versions. ### Homebrew -If you have Homebrew installed and prefer to use it, here's how. +1. Run `brew cask install zulip` in Terminal. +1. Run Zulip from `Applications`. -1. Run `brew cask install zulip` in your terminal -2. Done! Run Zulip from `Applications`. -3. The app will update automatically to future versions. - (`brew upgrade` will also work, if you prefer.) +The app will update automatically to future versions. `brew upgrade` will +also work, if you prefer. ## Installing on Windows -### Installer (recommended) +### Web installer (recommended) -1. Download and run [Zulip-Web-Setup-x.x.x.exe][latest] -2. The installer will download and install the app. -3. Done! Run Zulip from the Start menu. -4. The app will update automatically to future versions. +1. Download and run [Zulip for Windows](https://zulipchat.com/apps/windows). +1. Run Zulip from the Start menu. + +The app will update automatically to future versions. ### Offline installer (for isolated networks) @@ -44,76 +43,70 @@ If you have Homebrew installed and prefer to use it, here's how. (common), or [zulip-x.x.x-ia32.nsis.7z][latest] for 32-bit (rare). 2. Copy the installer file to the machine you want to install the app on, and run it there. -3. Done! Run Zulip from the Start menu. -4. The app will NOT update automatically. You can repeat these steps - to upgrade to future versions. +3. Run Zulip from the Start menu. + +The app will NOT update automatically. You can repeat these steps to upgrade +to future versions. ## Installing on Linux -### apt (recommended for Ubuntu or Debian 8+) +### apt (Ubuntu or Debian 8+) -1. Set up the Zulip Desktop apt repository and its signing key, from a - terminal: +1. Enter the following commands into a terminal: sudo apt-key adv --keyserver pool.sks-keyservers.net --recv 69AD12704E71A4803DCA3A682424BE5AE9BD10D9 echo "deb https://dl.bintray.com/zulip/debian/ stable main" | \ sudo tee -a /etc/apt/sources.list.d/zulip.list - -2. Install the client, from a terminal: - sudo apt update sudo apt install zulip -3. Done! Run Zulip from your app launcher, or with `zulip` from a - terminal. -4. The app will be updated automatically to future versions when - you do a regular software update on your system, e.g. with - `sudo apt update && sudo apt upgrade`. + These commands set up the Zulip Desktop apt repository and its signing + key, and then install the Zulip client. + +1. Run Zulip from your app launcher, or with `zulip` from a terminal. + +The app will be updated automatically to future versions when you do a +regular software update on your system, e.g. with +`sudo apt update && sudo apt upgrade`. ### AppImage (recommended for all other distros) -1. Download [Zulip-x.x.x-x86_64.AppImage][latest] +1. Download [Zulip for Linux](https://zulipchat.com/apps/linux). 2. Make the file executable, with - `chmod a+x Zulip-x.x.x-x86_64.AppImage` from a terminal. -3. Done! No installer necessary; this file is the Zulip app. Run it - from your app launcher, or from a terminal. -3. The app will NOT update automatically. You can repeat these steps - to upgrade to future versions. + `chmod a+x Zulip-x.x.x-x86_64.AppImage` from a terminal (replace + `x.x.x` with the actual name of the downloaded file). +3. Run the file from your app launcher, or from a terminal. + +No installer is necessary; this file is the Zulip app. The app will NOT +update automatically. You can repeat these steps to upgrade to future versions. -# Beta releases +## Beta releases -Get a peek at new features before they're released! If you'd like to -be among the first to get new features in the Zulip desktop app, and -to give the Zulip developers feedback to help make each stable release -the best it can be, then you might like the beta releases. +Get a peek at new features before they're released! -## Installing on macOS, Windows, or Linux with AppImage +### MacOS, Windows, and most Linux distros Start by finding the latest version marked "Pre-release" on the -[release list page][release-list]. Then follow the instructions -above, except download the Zulip installer or app from that version -instead of from the latest stable release. +[release list page][release-list]. There may or may not be a "Pre-release" +later than the latest release. If there is, download the approriate Zulip +installer or app from there, and follow the instructions for your operating +system above. -## Installing on Linux with apt +### Linux with apt (Ubuntu or Debian 8+) -Follow the instructions above, except in the step involving -`/etc/apt/sources.list.d/zulip.list`, write "beta" instead of -"stable". +If installing from scratch, follow the instructions above, except in the +command starting `echo "deb https://...` replace `stable` with `beta`. -If you already have the stable version installed: edit that file, with -this command in a terminal: +If you've already installed the stable version, edit `zulip.list` and +reinstall: ``` sudo sed -i s/stable/beta/ /etc/apt/sources.list.d/zulip.list -``` -and repeat the next step: -``` sudo apt update sudo apt install zulip ``` - [latest]: https://github.com/zulip/zulip-electron/releases/latest [release-list]: https://github.com/zulip/zulip-electron/releases