<commit_before>

=================
Zulip for Android
=================

This is the Android client for `Zulip <http://www.zulip.org>`_.  It is
available `in the Google Play store
<https://play.google.com/store/apps/details?id=com.zulip.android>`_.
If you have a taste for adventure, you can also `join our beta channel
<https://play.google.com/apps/testing/com.zulip.android>`_ after which
the Play store should auto-update you. (Caution: beta releases will
have more bugs than final releases, including (potentially) security
or data loss bugs.)

This is a Gradle project, and can be built via the provided ``gradlew``
or by using Android Studio.

Index

-  `Getting Started`_
-  `Build instructions (Android Studio)`_)
-  `Build instructions (without Android Studio)`_)
-  `Running server on device`_
-  `Coding Style`_
-  `Mailing List`_
-  `Export`_
-  `License`_

.. _Getting Started: #getting-started
.. _Build instructions (Android Studio): #build-instructions-android-studio
.. _Build instructions (without Android Studio): #build-instructions-without-android-studio
.. _Running server on device: #browsing-server-on-device
.. _Coding Style: #coding-style
.. _Mailing List: #mailing-list
.. _Export: #export
.. _License: #license

Getting Started
---------------

-  Firstly setup a development environment of the Zulip python Server
   https://github.com/zulip/zulip/blob/master/README.dev.md#brief-installation-instructions-for-vagrant-development-environment
-  Now follow the build instructions to compile the project
-  And then follow `Running server on device`_ to get the server running
   on the device.

.. _Running server on device: #browsing-server-on-device

Build instructions (Android Studio)
-----------------------------------

1. Open the project in the IDE.
    a) From the "Welcome to Android Studio" menu, select "Open an
       existing Android Studio project" option, or
    b) If you already have an opened project, select "File > Open..."

2. If you want to test Google sign in, add the required metadata:
    1. Go to https://developers.google.com/mobile/add?platform=android
    2. Type in "Zulip" as "App name" and "com.zulip.android" as
       "Android package name".)
    3. Put the generated file in the "app/" directory of the project.
    4. Google app id. You will also get it from the above given link.
       This id should be written as the following string resource in
       ``app/src/main/res/values/strings.xml``::
            <string name="google_app_id">GOOGLE_APP_ID</string>

If you have a device running Android go to the settings and enable USB
debugging in developer options. Then plug your device in the computer
and select "Run > Run...".  You will be shown "Device chooser" window.
Select your device in the given list and press "OK".

If you do not have an Android device you will have to run it on an
emulator. Here are instructions for creating an Android virtual device
(AVD):

http://developer.android.com/tools/devices/managing-avds.html#createavd<commit_msg>docs: Clean up getting started instructions and fix link.<commit_after>

=================
Zulip for Android
=================

This is the Android client for `Zulip <http://www.zulip.org>`_.  It is
available `in the Google Play store
<https://play.google.com/store/apps/details?id=com.zulip.android>`_.
If you have a taste for adventure, you can also `join our beta channel
<https://play.google.com/apps/testing/com.zulip.android>`_ after which
the Play store should auto-update you. (Caution: beta releases will
have more bugs than final releases, including (potentially) security
or data loss bugs.)

This is a Gradle project, and can be built via the provided ``gradlew``
or by using Android Studio.

Index

-  `Getting Started`_
-  `Build instructions (Android Studio)`_)
-  `Build instructions (without Android Studio)`_)
-  `Running server on device`_
-  `Coding Style`_
-  `Mailing List`_
-  `Export`_
-  `License`_

.. _Getting Started: #getting-started
.. _Build instructions (Android Studio): #build-instructions-android-studio
.. _Build instructions (without Android Studio): #build-instructions-without-android-studio
.. _Running server on device: #browsing-server-on-device
.. _Coding Style: #coding-style
.. _Mailing List: #mailing-list
.. _Export: #export
.. _License: #license

Getting Started
---------------

-  First, setup a development environment of the Zulip Server:
   http://zulip.readthedocs.io/en/latest/dev-overview.html
-  Then, follow the build instructions (below) to compile the project
-  And then follow `Running server on device`_ to get the device to
   connect to the Zulip development server.

.. _Running server on device: #browsing-server-on-device

Build instructions (Android Studio)
-----------------------------------

1. Open the project in the IDE.
    a) From the "Welcome to Android Studio" menu, select "Open an
       existing Android Studio project" option, or
    b) If you already have an opened project, select "File > Open..."

2. If you want to test Google sign in, add the required metadata:
    1. Go to https://developers.google.com/mobile/add?platform=android
    2. Type in "Zulip" as "App name" and "com.zulip.android" as
       "Android package name".)
    3. Put the generated file in the "app/" directory of the project.
    4. Google app id. You will also get it from the above given link.
       This id should be written as the following string resource in
       ``app/src/main/res/values/strings.xml``::
            <string name="google_app_id">GOOGLE_APP_ID</string>

If you have a device running Android go to the settings and enable USB
debugging in developer options. Then plug your device in the computer
and select "Run > Run...".  You will be shown "Device chooser" window.
Select your device in the given list and press "OK".

If you do not have an Android device you will have to run it on an
emulator. Here are instructions for creating an Android virtual device
(AVD):

http://developer.android.com/tools/devices/managing-avds.html#createavd
{'fraction_non_alphanumeric': 0.11757896477592195, 'fraction_numerical': 0.001984455101703324, 'mean_word_length': 3.5269461077844313, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 17, 'https://': 7, 'lorem ipsum': 0, 'www.': 2, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3971298', 'n_tokens_mistral': 1745, 'n_tokens_neox': 1702, 'n_words': 720}