Skip to content

Commit f1343bc

Browse files
committed
README: Expand upon text for keeping installations up to date.
This splits this part into the two types of install: stable and git. To synchronize with the installation details above, those are slightly reworded to match the new titles. Other changes: - Note there is no automatic upgrade system - Recommend reading changelog before upgrading between stable releases - Note there is no changelog between git versions, but the commit log is readable - Simplify text to indicate where announcements are made on chat.zulip.org - Note that with an account one can receive email notifications from #announce - Expand GitHub and PyPI notification details
1 parent 1785ee6 commit f1343bc

File tree

1 file changed

+43
-14
lines changed

1 file changed

+43
-14
lines changed

README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ In some cases this can give rise to the symptoms in issue #1145.
111111
We recommend installing in a dedicated python virtual environment (see below)
112112
or using an automated option such as [pipx](https://pypi.python.org/pypi/pipx)
113113

114-
* **Stable** - Numbered stable releases are available on PyPI as the package
114+
* **Stable releases** - These are available on PyPI as the package
115115
[zulip-term](https://pypi.python.org/pypi/zulip-term)
116116

117117
To install, run a command like: `pip3 install zulip-term`
118118

119-
* **Latest** - The latest development version can be installed from the main
120-
git repository
119+
* **Latest (git) versions** - The latest development version can be installed
120+
from the git repository `main` branch
121121

122122
To install, run a command like:
123123
`pip3 install git+https://github.com/zulip/zulip-terminal.git@main`
@@ -143,17 +143,46 @@ You can read more about virtual environments in the
143143

144144
### Keeping your install up to date
145145

146-
Stable releases are made available on PyPI and GitHub; to ensure you keep up to
147-
date with them we suggest checking those sites for updates.
148-
Stable releases are also announced in the #**announce** stream on the Zulip
149-
Community server (https://chat.zulip.org), where you are welcome to make an
150-
account; future releases are expected to be announced in #**announce>terminal
151-
releases**.
152-
153-
If running from the `main` git branch, note that this does not automatically
154-
update, and you must do so manually.
155-
This also applies to other source or development installs, including eg.
156-
https://aur.archlinux.org/packages/python-zulip-term-git/
146+
Note that there is no automatic-update system, so please track the update
147+
locations relevant to your installation version:
148+
149+
**Stable releases**
150+
151+
Before upgrading, we recommend you check the
152+
[Changes in recent releases](https://github.com/zulip/zulip-terminal/blob/main/CHANGELOG.md)
153+
so you are aware of any important changes between releases.
154+
155+
- These are now announced in the
156+
[#**announce>terminal releases**](https://chat.zulip.org/#narrow/stream/1-announce/topic/terminal.20releases)
157+
topic on the Zulip Community server (https://chat.zulip.org), which is visible
158+
without an account.
159+
160+
If you wish to receive emails when updates are announced, you are welcome to
161+
sign up for an account on this server, which will enable you to enable email
162+
notifications for the **#announce** stream
163+
([help article](https://zulip.com/help/using-zulip-via-email),
164+
[notifications settings on chat.zulip.org](https://chat.zulip.org/#settings/notifications)).
165+
166+
- You can also customize your GitHub Watch setting on the project page to include releases.
167+
168+
- PyPI provides a
169+
[RSS Release feed](https://pypi.org/rss/project/zulip-term/releases.xml), and
170+
various other services track this information.
171+
172+
**Latest (git) versions**
173+
174+
Versions installed from the `main` git branch will also not update
175+
automatically - the 'latest' refers to the status at the point of installation.
176+
177+
This also applies to other source or development installs
178+
(eg. https://aur.archlinux.org/packages/python-zulip-term-git/).
179+
180+
Therefore, upgrade your package using the command above, or one pertinent to
181+
your package system (eg. Arch).
182+
183+
While the `main` branch is intended to remain stable, if upgrading between two
184+
arbitrary 'latest' versions, please be aware that **changes are not summarized**,
185+
though our commit log should be very readable.
157186

158187
## Running for the first time
159188

0 commit comments

Comments
 (0)