Skip to content
This repository was archived by the owner on Jul 25, 2024. It is now read-only.

Commit e2e325e

Browse files
committed
docs: Clarify getting started and help recommendations.
1 parent 7d42d60 commit e2e325e

File tree

1 file changed

+40
-20
lines changed

1 file changed

+40
-20
lines changed

README.rst

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,34 @@ or by using Android Studio.
4343
Getting Started
4444
---------------
4545

46-
- First, setup a development environment of the Zulip Server:
47-
http://zulip.readthedocs.io/en/latest/dev-overview.html
48-
49-
For first time contributors you can also authenticate from https://zulip.tabbott.net/ but only for demo purposes and not be used for development as this is an ongoing chat server, and being heavily used!
50-
- Then, follow the build instructions (below) to compile the project
51-
- And then follow `Running server on device`_ to get the device to
52-
connect to the Zulip development server.
46+
- First, clone this repository and follow the Android Studio build
47+
instructions (below) to compile the project. If you don't have an
48+
existing Zulip account to login with, you can create one on the
49+
Zulip development community server at https://zulip.tabbott.net/.
50+
Note that this server is used for development discussions, so don't
51+
use it for sending lots of test messages!
5352

54-
.. _Running server on device: #browsing-server-on-device
53+
- For testing, it can be helpful to have your own Zulip development
54+
server that the app can connect to. Instructions for setting up a
55+
Zulip development server are here:
56+
http://zulip.readthedocs.io/en/latest/dev-overview.html
57+
58+
- And then follow the `Connecting to a development server`_ guide to get the
59+
Android app to connect to the Zulip development server.
60+
61+
.. _Connecting to a development server: #connecting-to-a-development-server
5562

5663
Getting Help
5764
---------------
58-
For questions on development for the Zulip Android App you can post a topic here
65+
66+
- For real-time help, you can join the Zulip development community's
67+
Zulip server at https://zulip.tabbott.net and post on the `android`
68+
stream.
69+
70+
- For questions on development for the Zulip Android App you can post here:
5971
https://groups.google.com/forum/#!forum/zulip-android
6072

61-
For questions on development for the Zulip Server you can post a topic here
73+
- For questions on development for the Zulip Server you can post here:
6274
https://groups.google.com/forum/#!forum/zulip-devel
6375

6476
Any issues or bugs should be posted in the Github Issue Tracker!
@@ -67,6 +79,8 @@ Any issues or bugs should be posted in the Github Issue Tracker!
6779
Build instructions (Android Studio)
6880
-----------------------------------
6981

82+
0. Fork the zulip-android repository from GitHub and clone your fork.
83+
7084
1. Open the project in the IDE.
7185
a) From the "Welcome to Android Studio" menu, select "Open an
7286
existing Android Studio project" option, or
@@ -150,29 +164,35 @@ Build instructions (without Android Studio)
150164
default because it is unsigned. You will be told the APK cannot be
151165
parsed.
152166

153-
Browsing server on device
154-
-------------------------
167+
Connecting to a development server
168+
----------------------------------
169+
170+
Once you are running a Zulip development server on your laptop, you
171+
will need to do some additional configuration of the Android
172+
development environment to connect to your development server.
155173

156-
| For a Vagrant server
157174
| If you are using a Genymotion Emulator you can access the server by
158175
browsing to http://10.0.3.2:9991 or http://10.0.3.1:9991 (one of these
159176
two URL’s)
160177
161-
To access the vagrant server on a physical device connect computer and
162-
mobile to the same network (router) modify ``VagrantFile`` `here`_ in
163-
the server change the host\_ip ‘127.0.0.1’ to ‘0.0.0.0’ Like this-
178+
To access the vagrant server on a physical device:
179+
180+
* connect the computer and Android device to the same network (router)
181+
182+
* modify ``VagrantFile`` `here`_ in the server change the host\_ip
183+
‘127.0.0.1’ to ‘0.0.0.0’ Like this-
164184

165185
config.vm.network “forwarded\_port”, guest: 9991, host: host\_port,
166186
host\_ip: “0.0.0.0”
167187

168-
Now find the IP address of the computer use this IP address and port
169-
number and browse the Zulip Server on the mobile device. For example -
188+
* Now find the IP address of the computer, and start the Android app.
189+
For the server, specify the computer's IP address and port number as
190+
the Zulip Server. For example:
170191

171192
192.168.0.1:9991
172193

173-
|
174194
| You can also route the IP address to a domain name like
175-
www.local.test.com (this routing is useful when tesing Google OAuth
195+
www.local.test.com (this routing is useful when testing the Google OAuth
176196
Backend)
177197
| No need to modify the ``VagrantFile`` to achieve this
178198

0 commit comments

Comments
 (0)