[MediaWiki-commits] [Gerrit] Update README - change (apps...wikipedia)
BearND has uploaded a new change for review. https://gerrit.wikimedia.org/r/178669 Change subject: Update README .. Update README Need JDK 7 now. Tried to be less Mac specific. Update Android Studio info to 1.0.0 Removed info about Maven and IntelliJ. Rearranged some chapters and added more info on how to contribute. Change-Id: Ib0200a84cb2be923d14fa1bc4da8f018fb1349ac --- M README.mediawiki 1 file changed, 99 insertions(+), 131 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/apps/android/wikipedia refs/changes/69/178669/1 diff --git a/README.mediawiki b/README.mediawiki index e895d99..260bebc 100644 --- a/README.mediawiki +++ b/README.mediawiki @@ -1,26 +1,43 @@ See also https://git.wikimedia.org/summary/apps%2Fandroid%2Fjava-mwapi.git -== Steps to Get Up and Developing on a Mac == +== Steps to Set Up a Development Environment == -These instructions should help a Mac owner download the Wikipedia for Android source code and get the latest version running in an emulator or on a real Android device. If you don't know anything about how to navigate around a UNIX/Linux/Mac filesystem and edit files with a program like pico, emacs, or vim, these instructions probably won't make any sense. And as noted below, you probably need to understand git in order to ever contribute source code updates to the new app. And regarding source code, you will need to probably be pretty good at Java or iOS programming, but more ideally the Android-flavored Java used in Android development to really get down to work or play quickly. If you use another shell than bash (e.g. zsh) then you'll probably know enough to adjust accordingly. But anyway, here we go for those who enjoy a fun side project for a good cause... +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 (aka. JDK) is needed to build Android apps. If in the Terminal you can type the command java -version and you don't have a $JAVA_HOME environment variable, Maven will probably Just Work on Mac, so you don't necessarily need to add and export JAVA_HOME in ~/.bash_profile like the instructions suggest. If, on the other hand you don't have Java, download and install the latest version of the Java SDK in the 1.6 series (or if unsupported, maybe 1.7, ...) and ensure you can get java -version to work. +The Java SDK 7 or higher (aka. JDK) is needed to build Android apps. To test: + javac -version === Install Android SDK === -1. Install brew if you don't already have it +It's probably best to install the Android SDK separately from Android Studio -- instead of the bundle. -See: http://brew.sh/ + On a Mac you can use brew +Install brew if you don't already have it. Instructions are at http://brew.sh. -2. Install Android SDK - +Install Android SDK brew update brew doctor brew install android -3. On a Mac, you'll want to 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. + 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 @@ -31,7 +48,7 @@ Now, and any time you open a new Terminal, the $ANDROID_HOME variable will be set
[MediaWiki-commits] [Gerrit] Update README - change (apps...wikipedia)
Dbrant has submitted this change and it was merged. Change subject: Update README .. Update README Need JDK 7 now. Tried to be less Mac specific. Update Android Studio info to 1.0.0 Removed info about Maven and IntelliJ. Rearranged some chapters and added more info on how to contribute. Change-Id: Ib0200a84cb2be923d14fa1bc4da8f018fb1349ac --- M README.mediawiki 1 file changed, 99 insertions(+), 131 deletions(-) Approvals: Dbrant: Looks good to me, approved jenkins-bot: Verified diff --git a/README.mediawiki b/README.mediawiki index e895d99..260bebc 100644 --- a/README.mediawiki +++ b/README.mediawiki @@ -1,26 +1,43 @@ See also https://git.wikimedia.org/summary/apps%2Fandroid%2Fjava-mwapi.git -== Steps to Get Up and Developing on a Mac == +== Steps to Set Up a Development Environment == -These instructions should help a Mac owner download the Wikipedia for Android source code and get the latest version running in an emulator or on a real Android device. If you don't know anything about how to navigate around a UNIX/Linux/Mac filesystem and edit files with a program like pico, emacs, or vim, these instructions probably won't make any sense. And as noted below, you probably need to understand git in order to ever contribute source code updates to the new app. And regarding source code, you will need to probably be pretty good at Java or iOS programming, but more ideally the Android-flavored Java used in Android development to really get down to work or play quickly. If you use another shell than bash (e.g. zsh) then you'll probably know enough to adjust accordingly. But anyway, here we go for those who enjoy a fun side project for a good cause... +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 (aka. JDK) is needed to build Android apps. If in the Terminal you can type the command java -version and you don't have a $JAVA_HOME environment variable, Maven will probably Just Work on Mac, so you don't necessarily need to add and export JAVA_HOME in ~/.bash_profile like the instructions suggest. If, on the other hand you don't have Java, download and install the latest version of the Java SDK in the 1.6 series (or if unsupported, maybe 1.7, ...) and ensure you can get java -version to work. +The Java SDK 7 or higher (aka. JDK) is needed to build Android apps. To test: + javac -version === Install Android SDK === -1. Install brew if you don't already have it +It's probably best to install the Android SDK separately from Android Studio -- instead of the bundle. -See: http://brew.sh/ + On a Mac you can use brew +Install brew if you don't already have it. Instructions are at http://brew.sh. -2. Install Android SDK - +Install Android SDK brew update brew doctor brew install android -3. On a Mac, you'll want to 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. + 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 @@ -31,7 +48,7 @@ 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
[MediaWiki-commits] [Gerrit] Update README. - change (apps...wikipedia)
Brion VIBBER has submitted this change and it was merged. Change subject: Update README. .. Update README. Removed a few sections of the README that were either out of date or irrelevant. Change-Id: I32cc9190558806cefe58421abbe48918c7310779 --- M README.md 1 file changed, 1 insertion(+), 9 deletions(-) Approvals: Brion VIBBER: Looks good to me, approved diff --git a/README.md b/README.md index d53fb54..4f50545 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ Native rewrite of the [Wikipedia reader application](https://www.mediawiki.org/wiki/Wikimedia_Apps/Wikipedia) for iOS. -Previous PhoneGap based app source: [WikipediaMobile project on GitHub](https://github.com/wikimedia/WikipediaMobile). - * OS target: iOS 6.0 or higher * Device target: iPhone, iPod, iPad * License: MIT-style @@ -27,7 +25,7 @@ You'll also need to install the following (used by build scripts): * [nodejs](http://nodejs.org/) and npm -* grunt-cli (run 'npm install -g grunt-cli') +* grunt-cli (run 'sudo npm install -g grunt-cli') * [Inkscape](http://www.inkscape.org/en/download/mac-os/) @@ -53,12 +51,6 @@ Components of the app will be relatively self-contained, communicating via NSNotificationCenter as a messaging bus to avoid over-close coupling of parts and to make test-driven development more feasible. - -# Design - -A major complaint about the currently deployed Wikipedia app is its non-iOS-y UI appearance and behavior. - -We'll be working with the Wikimedia Foundation's Design team on UI design, with an eye to coordinating the look branding with mobile web and Android while keeping a nice native iOS 7 feel. # Development team -- To view, visit https://gerrit.wikimedia.org/r/168545 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I32cc9190558806cefe58421abbe48918c7310779 Gerrit-PatchSet: 2 Gerrit-Project: apps/ios/wikipedia Gerrit-Branch: master Gerrit-Owner: Deskana dga...@wikimedia.org Gerrit-Reviewer: Brion VIBBER br...@wikimedia.org Gerrit-Reviewer: jenkins-bot ___ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
[MediaWiki-commits] [Gerrit] Update README. - change (apps...wikipedia)
Deskana has uploaded a new change for review. https://gerrit.wikimedia.org/r/168545 Change subject: Update README. .. Update README. Removed a few sections of the README that were either out of date or irrelevant. Change-Id: I32cc9190558806cefe58421abbe48918c7310779 --- M README.md 1 file changed, 0 insertions(+), 8 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/apps/ios/wikipedia refs/changes/45/168545/1 diff --git a/README.md b/README.md index d53fb54..9c7269f 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ Native rewrite of the [Wikipedia reader application](https://www.mediawiki.org/wiki/Wikimedia_Apps/Wikipedia) for iOS. -Previous PhoneGap based app source: [WikipediaMobile project on GitHub](https://github.com/wikimedia/WikipediaMobile). - * OS target: iOS 6.0 or higher * Device target: iPhone, iPod, iPad * License: MIT-style @@ -53,12 +51,6 @@ Components of the app will be relatively self-contained, communicating via NSNotificationCenter as a messaging bus to avoid over-close coupling of parts and to make test-driven development more feasible. - -# Design - -A major complaint about the currently deployed Wikipedia app is its non-iOS-y UI appearance and behavior. - -We'll be working with the Wikimedia Foundation's Design team on UI design, with an eye to coordinating the look branding with mobile web and Android while keeping a nice native iOS 7 feel. # Development team -- To view, visit https://gerrit.wikimedia.org/r/168545 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I32cc9190558806cefe58421abbe48918c7310779 Gerrit-PatchSet: 1 Gerrit-Project: apps/ios/wikipedia Gerrit-Branch: master Gerrit-Owner: Deskana dga...@wikimedia.org ___ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
