docs/README: Complete 'Getting Started' user tutorial.

The existing tutorial for new users was incomplete; this improves, expands and completes it. Images for the tutorial are in docs/getting-started-imgs. Fixes zulip#221.
Rohitth007 · Apr 1, 2021 · 6b22249 · 6b22249
1 parent f9d0982
commit 6b22249
Show file tree

Hide file tree

Showing 28 changed files with 190 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Zulip Terminal - [Zulip](https://zulip.com)'s official terminal client
 
-[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)
+[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)
 
 [![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org/#narrow/stream/206-zulip-terminal)
 [![PyPI](https://img.shields.io/pypi/v/zulip-term.svg)](https://pypi.python.org/pypi/zulip-term)
@@ -21,6 +21,8 @@ Specific aims include:
 * Exploring alternative user interface designs suited to the display and input constraints
 * Supporting a wide range of platforms and terminal emulators
 
+Learn how to use Zulip Terminal with our [Tutorial](https://github.com/zulip/zulip-terminal/blob/main/docs/getting-started.md).
+
 ### Feature status
 
 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:
 
 **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/).
 
-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.
+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.
 
 ## Configuration
 

diff --git a/docs/getting-started-imgs/current-narrow.png b/docs/getting-started-imgs/current-narrow.png
diff --git a/docs/getting-started-imgs/edit-message.png b/docs/getting-started-imgs/edit-message.png
diff --git a/docs/getting-started-imgs/help.png b/docs/getting-started-imgs/help.png
diff --git a/docs/getting-started-imgs/layout3.png b/docs/getting-started-imgs/layout3.png
diff --git a/docs/getting-started-imgs/narrow-stream.png b/docs/getting-started-imgs/narrow-stream.png
diff --git a/docs/getting-started-imgs/narrow-topic.png b/docs/getting-started-imgs/narrow-topic.png
diff --git a/docs/getting-started-imgs/new-topic.png b/docs/getting-started-imgs/new-topic.png
diff --git a/docs/getting-started-imgs/raw/current-narrow-raw.png b/docs/getting-started-imgs/raw/current-narrow-raw.png
diff --git a/docs/getting-started-imgs/raw/edit-message-raw.png b/docs/getting-started-imgs/raw/edit-message-raw.png
diff --git a/docs/getting-started-imgs/raw/narrow-stream-raw.png b/docs/getting-started-imgs/raw/narrow-stream-raw.png
diff --git a/docs/getting-started-imgs/raw/narrow-topic-raw.png b/docs/getting-started-imgs/raw/narrow-topic-raw.png
diff --git a/docs/getting-started-imgs/raw/new-topic-raw.png b/docs/getting-started-imgs/raw/new-topic-raw.png
diff --git a/docs/getting-started-imgs/raw/read-messages-raw.png b/docs/getting-started-imgs/raw/read-messages-raw.png
diff --git a/docs/getting-started-imgs/raw/reply-raw.png b/docs/getting-started-imgs/raw/reply-raw.png
diff --git a/docs/getting-started-imgs/raw/send-pm-autocomplete1-raw.png b/docs/getting-started-imgs/raw/send-pm-autocomplete1-raw.png
diff --git a/docs/getting-started-imgs/raw/send-pm-autocomplete2-raw.png b/docs/getting-started-imgs/raw/send-pm-autocomplete2-raw.png
diff --git a/docs/getting-started-imgs/raw/send-pm-raw.png b/docs/getting-started-imgs/raw/send-pm-raw.png
diff --git a/docs/getting-started-imgs/raw/thumbs-up-raw.png b/docs/getting-started-imgs/raw/thumbs-up-raw.png
diff --git a/docs/getting-started-imgs/read-messages.png b/docs/getting-started-imgs/read-messages.png
diff --git a/docs/getting-started-imgs/reply-to-message.png b/docs/getting-started-imgs/reply-to-message.png
diff --git a/docs/getting-started-imgs/send-pm-autocomplete1.png b/docs/getting-started-imgs/send-pm-autocomplete1.png
diff --git a/docs/getting-started-imgs/send-pm-autocomplete2.png b/docs/getting-started-imgs/send-pm-autocomplete2.png
diff --git a/docs/getting-started-imgs/send-pm.png b/docs/getting-started-imgs/send-pm.png
diff --git a/docs/getting-started-imgs/thumbs-up.png b/docs/getting-started-imgs/thumbs-up.png
diff --git a/docs/getting-started-imgs/understand-layout.png b/docs/getting-started-imgs/understand-layout.png
diff --git a/docs/getting-started-imgs/your-cursor.png b/docs/getting-started-imgs/your-cursor.png
diff --git a/docs/getting-started.md b/docs/getting-started.md