Skip to content

Commit 55a2d90

Browse files
committed
docs: Complete 'Getting Started' user tutorial.
The existing tutorial for new users was incomplete. We decided to improve, expand and complete it. Images for the tutorial are in docs/getting-started-imgs. Fixes #221.
1 parent 8263ab9 commit 55a2d90

28 files changed

+190
-16
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Zulip Terminal - [Zulip](https://zulip.com)'s official terminal client
22

3-
[Recent changes](https://github.com/zulip/zulip-terminal/blob/main/CHANGELOG.md) | [Configuration](#Configuration) | [Hot Keys](https://github.com/zulip/zulip-terminal/blob/main/docs/hotkeys.md) | [FAQs](https://github.com/zulip/zulip-terminal/blob/main/docs/FAQ.md) | [Development](#contributor-guidelines)
3+
[Recent changes](https://github.com/zulip/zulip-terminal/blob/main/CHANGELOG.md) | [Configuration](#Configuration) | [Hot Keys](https://github.com/zulip/zulip-terminal/blob/main/docs/hotkeys.md) | [FAQs](https://github.com/zulip/zulip-terminal/blob/main/docs/FAQ.md) | [Development](#contributor-guidelines) | [Tutorial](https://github.com/zulip/zulip-terminal/blob/main/docs/getting-started.md)
44

55
[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org/#narrow/stream/206-zulip-terminal)
66
[![PyPI](https://img.shields.io/pypi/v/zulip-term.svg)](https://pypi.python.org/pypi/zulip-term)
@@ -21,6 +21,8 @@ Specific aims include:
2121
* Exploring alternative user interface designs suited to the display and input constraints
2222
* Supporting a wide range of platforms and terminal emulators
2323

24+
Learn how to use Zulip Terminal with our [Tutorial](https://github.com/zulip/zulip-terminal/blob/main/docs/getting-started.md).
25+
2426
### Feature status
2527

2628
We consider the client to already provide a fairly stable moderately-featureful everyday-user experience.
@@ -84,7 +86,7 @@ If it doesn't find this file, you have two options:
8486

8587
**NOTE:** If your server uses self-signed certificates or an insecure connection, you will need to add extra options to the `zuliprc` file manually - see the documentation for the [Zulip python module](https://pypi.org/project/zulip/).
8688

87-
We suggest running `zulip-term` using the `-e` or `--explore` option (in explore mode) when you are trying Zulip Terminal for the first time, where we intentionally do not mark messages as read.
89+
We suggest running `zulip-term` using the `-e` or `--explore` option (in explore mode) when you are trying Zulip Terminal for the first time, where we intentionally do not mark messages as read. Try following along with our [Tutorial](https://github.com/zulip/zulip-terminal/blob/main/docs/getting-started.md) to get the hang of things.
8890

8991
## Configuration
9092

195 KB
Loading
128 KB
Loading

docs/getting-started-imgs/help.png

158 KB
Loading

docs/getting-started-imgs/layout3.png

198 KB
Loading
196 KB
Loading
171 KB
Loading
181 KB
Loading
Loading
Loading

0 commit comments

Comments
 (0)