[MediaWiki-commits] [Gerrit] Update README for Android Studio 1.0.0 - change (apps...wikipedia)
Dbrant has submitted this change and it was merged. Change subject: Update README for Android Studio 1.0.0 .. Update README for Android Studio 1.0.0 Change-Id: I6678f620564c569944675344806c8326e417af12 --- M README.mediawiki 1 file changed, 44 insertions(+), 141 deletions(-) Approvals: Dbrant: Looks good to me, approved diff --git a/README.mediawiki b/README.mediawiki index e6c3210..ff5bbeb 100644 --- a/README.mediawiki +++ b/README.mediawiki @@ -4,165 +4,57 @@ These instructions should help you download the Wikipedia for Android source code and get the latest version running in an emulator or on a real Android device. Some of the steps assume you are using bash but should be easily translatable for other shells as well. We've written theses instructions initially for OS X but most should also work on Linux and Windows. But anyway, here we go for those who enjoy a fun side project for a good cause... -=== Git === - -We assume you already have Git installed. If you've never used Git, you will need to search the web on how to add git to the system from Apple Xcode, and then study on how to use git (look for material on https://mediawiki.org for git convention as practiced by MediaWiki programmers). - -In the parent directory of your programming projects, run the following commands: - git clone https://git.wikimedia.org/git/apps/android/wikipedia.git - -Assuming the git clone operation worked, you will have a new folder representing the freshly cloned repository, wikipedia. - -It is recommended to rename the folder for the wikipedia repository to ensure you know which OS it's for (there's an iOS app by the name of wikipedia, too, so it's good to have different folder names at the root of the repos). - mv wikipedia/ android-wikipedia/ - === Install Java SDK === The Java SDK 7 or higher (aka. JDK) is needed to build Android apps. To test: javac -version -=== Install Android SDK === +=== Install Android Studio and Android SDK === -It's probably best to install the Android SDK separately from Android Studio -- instead of the bundle. - - On a Mac you can use brew -Install brew if you don't already have it. Instructions are at http://brew.sh. - -Install Android SDK - brew update - brew doctor - brew install android - - Other Platforms -Download the SDK Tools from http://developer.android.com/sdk/index.html#Other - - All Platforms -Update your ~/.bash_profile file to set the $ANDROID_HOME variable to point to the 'sdk' folder contained in the compressed file you just extracted and to update your system path to point at some binaries. - - export ANDROID_HOME=/usr/local/opt/android-studio-sdk - export PATH=$ANDROID_HOME/tools:$PATH - -Source your your ~/.bash_profile - - source ~/.bash_profile - -Now, and any time you open a new Terminal, the $ANDROID_HOME variable will be set automatically and you'll be able to run command line tools pertinent to Android software development, such as the tool aptly named android. - -Install the Android SDK components needed for the Wikipedia Android app: - android update sdk -u --filter tools,platform-tools,build-tools-21.1.1,android-21,extra-android-m2repository - -After you accept the licenses, this will download and install the necessary SDK components for you to build the app. - -You can find more components via: - android list sdk -e -a - -Alternatively, you can use the GUI: - android - -This will load a GUI tool called Android SDK Manager for managing the Android-related packages necessary for Android programming. - -You may want to install some more packages from there. - -=== Optional: Install Android Emulator === - -It's usually best to run the app on real devices, but sometimes it's useful to use an emulator when a certain physical device is not available, like a different form factor (7, 10 tablet, ...). - -If planning to use Android emulators, consider adding the System Image packages of various API levels in in the Android SDK Manager. -Example: -* ARM EABI v7a System Image (API 21) - -You'll probably also want to install the HAXM installer package from the Extras category at the bottom. -* Intel X86 Emulator Accelerator (HAXM installer) - -Once you're satisfied that everything has been downloaded and installed, feel free to close the Android SDK Manager. - -If you've downloaded the Intel HAXM installer you're not done yet. You also need to run the installer. (Sometimes it's also useful to run it later again). -You can find the dmg in $ANDROID_HOME/extras/intel/Hardware_Accelerated_Execution_Manager. -Select a good memory limit. It depends on your machine. Some got it set to 2048 MB. - - -To set up actual emulators you'd want to run the following command in Terminal (or from Android Studio): - - android avd - -This will launch the Android Virtual Device Manager application where you can create different virtual machines
[MediaWiki-commits] [Gerrit] Update README for Android Studio 1.0.0 - change (apps...wikipedia)
BearND has uploaded a new change for review. https://gerrit.wikimedia.org/r/180723 Change subject: Update README for Android Studio 1.0.0 .. Update README for Android Studio 1.0.0 Change-Id: I6678f620564c569944675344806c8326e417af12 --- M README.mediawiki 1 file changed, 44 insertions(+), 141 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/apps/android/wikipedia refs/changes/23/180723/1 diff --git a/README.mediawiki b/README.mediawiki index e6c3210..ff5bbeb 100644 --- a/README.mediawiki +++ b/README.mediawiki @@ -4,165 +4,57 @@ These instructions should help you download the Wikipedia for Android source code and get the latest version running in an emulator or on a real Android device. Some of the steps assume you are using bash but should be easily translatable for other shells as well. We've written theses instructions initially for OS X but most should also work on Linux and Windows. But anyway, here we go for those who enjoy a fun side project for a good cause... -=== Git === - -We assume you already have Git installed. If you've never used Git, you will need to search the web on how to add git to the system from Apple Xcode, and then study on how to use git (look for material on https://mediawiki.org for git convention as practiced by MediaWiki programmers). - -In the parent directory of your programming projects, run the following commands: - git clone https://git.wikimedia.org/git/apps/android/wikipedia.git - -Assuming the git clone operation worked, you will have a new folder representing the freshly cloned repository, wikipedia. - -It is recommended to rename the folder for the wikipedia repository to ensure you know which OS it's for (there's an iOS app by the name of wikipedia, too, so it's good to have different folder names at the root of the repos). - mv wikipedia/ android-wikipedia/ - === Install Java SDK === The Java SDK 7 or higher (aka. JDK) is needed to build Android apps. To test: javac -version -=== Install Android SDK === +=== Install Android Studio and Android SDK === -It's probably best to install the Android SDK separately from Android Studio -- instead of the bundle. - - On a Mac you can use brew -Install brew if you don't already have it. Instructions are at http://brew.sh. - -Install Android SDK - brew update - brew doctor - brew install android - - Other Platforms -Download the SDK Tools from http://developer.android.com/sdk/index.html#Other - - All Platforms -Update your ~/.bash_profile file to set the $ANDROID_HOME variable to point to the 'sdk' folder contained in the compressed file you just extracted and to update your system path to point at some binaries. - - export ANDROID_HOME=/usr/local/opt/android-studio-sdk - export PATH=$ANDROID_HOME/tools:$PATH - -Source your your ~/.bash_profile - - source ~/.bash_profile - -Now, and any time you open a new Terminal, the $ANDROID_HOME variable will be set automatically and you'll be able to run command line tools pertinent to Android software development, such as the tool aptly named android. - -Install the Android SDK components needed for the Wikipedia Android app: - android update sdk -u --filter tools,platform-tools,build-tools-21.1.1,android-21,extra-android-m2repository - -After you accept the licenses, this will download and install the necessary SDK components for you to build the app. - -You can find more components via: - android list sdk -e -a - -Alternatively, you can use the GUI: - android - -This will load a GUI tool called Android SDK Manager for managing the Android-related packages necessary for Android programming. - -You may want to install some more packages from there. - -=== Optional: Install Android Emulator === - -It's usually best to run the app on real devices, but sometimes it's useful to use an emulator when a certain physical device is not available, like a different form factor (7, 10 tablet, ...). - -If planning to use Android emulators, consider adding the System Image packages of various API levels in in the Android SDK Manager. -Example: -* ARM EABI v7a System Image (API 21) - -You'll probably also want to install the HAXM installer package from the Extras category at the bottom. -* Intel X86 Emulator Accelerator (HAXM installer) - -Once you're satisfied that everything has been downloaded and installed, feel free to close the Android SDK Manager. - -If you've downloaded the Intel HAXM installer you're not done yet. You also need to run the installer. (Sometimes it's also useful to run it later again). -You can find the dmg in $ANDROID_HOME/extras/intel/Hardware_Accelerated_Execution_Manager. -Select a good memory limit. It depends on your machine. Some got it set to 2048 MB. - - -To set up actual emulators you'd want to run the following command in Terminal (or from Android Studio): - - android avd - -This will launch the Android
