jenkins-bot has submitted this change and it was merged. Change subject: Minor improvements to readme ......................................................................
Minor improvements to readme * Use Pip instead of EasyInstall. * Add note on Vagrant / emulator conflict. * Add note on code, commit, and doc conventions. * Fix some capitalizations. Change-Id: I0d5e7e39f057635758fbfc601aa20aed8b79e1c5 --- M README.mediawiki 1 file changed, 19 insertions(+), 10 deletions(-) Approvals: BearND: Looks good to me, approved jenkins-bot: Verified diff --git a/README.mediawiki b/README.mediawiki index edfacb6..c2246a0 100644 --- a/README.mediawiki +++ b/README.mediawiki @@ -1,6 +1,6 @@ -== Steps to Set Up a Development Environment == +== Steps to set up a development environment == -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... +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... === Install Java SDK === @@ -39,7 +39,7 @@ Once the import is complete, you can change the build variant to devDebug but leaving it at alphaDebug is fine, too. To do so see the Build Variants tab on the left hand side of Android Studio. If you don't see any tabs on the side click on the button in the lower left, which looks like a computer display. -==== Run / Debug the app ==== +==== Run / debug the app ==== Android Studio generates a run configuration automatically now. So, all you have to do to run the app is to click on the green play or debug button in the middle of the toolbar, next to the name of the run configuration. If you need more run configurations go to Run > Edit Configurations again, click the '+' symbol, choose Android Application, set the Module to 'wikipedia'. @@ -54,7 +54,7 @@ chrome://inspect/#devices Then click on the topmost "inspect" link under "WebView in org.wikipedia". From there you can debug the WebView side like any other web site in Chrome. -==== Logcat Configuration ==== +==== Logcat configuration ==== After starting the project you'll likely notice a torrent of messages in the logcat window, and so it can help to setup a filter to cut down on those messages. @@ -64,7 +64,7 @@ * Because the log level can be changed on the main interface, it may be helpful to leave the level set to "Verbose" * Select "OK" -==== Android Studio Plugins ==== +==== Android Studio plugins ==== * Checkstyle Configuration to see Checkstyle errors as you type @@ -119,7 +119,7 @@ More info: http://developer.android.com/sdk/installing/studio-build.html -===MW API Library=== +=== MW API library === The Wikipedia app uses the MediaWiki Java API, which is also maintained by the Android team. The Git repo is here: https://git.wikimedia.org/summary/apps%2Fandroid%2Fjava-mwapi.git @@ -133,7 +133,7 @@ * Production releases: https://play.google.com/store/apps/details?id=org.wikipedia === Contribute code via Gerrit === -Sorry, Github pull requests are currently not working. +Sorry, GitHub pull requests are currently not working. Learn about Gerrit and how to submit patches in this [http://www.mediawiki.org/wiki/Gerrit/Getting_started short guide] or the [http://www.mediawiki.org/wiki/Gerrit/Tutorial tutorial]. See pending/recent code reviews: @@ -149,8 +149,8 @@ === Update bundled CSS files === The various CSS files for this project are generated by the (mainly *.less) files found in the MobileApp MediaWiki extension. -[https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/MobileApp Gerrit] or [https://github.com/wikimedia/mediawiki-extensions-MobileApp Github]. -You'll need a MediaWiki installation, [https://www.mediawiki.org/wiki/Mediawiki-vagrant Mediawiki-vagrant] recommended, to run generate this. +[https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/extensions/MobileApp Gerrit] or [https://github.com/wikimedia/mediawiki-extensions-MobileApp GitHub]. +You'll need a MediaWiki installation, [https://www.mediawiki.org/wiki/MediaWiki-Vagrant MediaWiki-Vagrant] recommended, to run generate this. in vagrant directory: vagrant enable-role mobileapp @@ -158,6 +158,8 @@ That will give you a mediawiki/extensions/MobileApp which will be a git repo. Next step is to change the url in (this repo/)scripts/make-css-assets.bash script to point to 127.0.0.1:8080/w instead of the bits url then run the script, and test. + +Note: your system may be unable to run the Android emulator and a Vagrant / VirtualBox instance simultaneously. === Update bundled JavaScript === @@ -196,7 +198,7 @@ ==== Setup ==== Install sh python module: - sudo easy_install sh + pip install sh Ensure you have librsvg and the 'rsvg-convert' command: @@ -230,3 +232,10 @@ cd scripts python make-templates.py mv *.java ../wikipedia/src/main/java/org/wikipedia/staticdata/ + + +== Conventions == +- Java code must run cleanly against Checkstyle +- JavaScript must run cleanly against JSHint +- Git commit messages should conform to the [https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines MediaWiki commit message guidelines] +- Documentation should conform to the [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style | Wikipedia manual of style] \ No newline at end of file -- To view, visit https://gerrit.wikimedia.org/r/205069 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I0d5e7e39f057635758fbfc601aa20aed8b79e1c5 Gerrit-PatchSet: 6 Gerrit-Project: apps/android/wikipedia Gerrit-Branch: master Gerrit-Owner: Niedzielski <[email protected]> Gerrit-Reviewer: BearND <[email protected]> Gerrit-Reviewer: Brion VIBBER <[email protected]> Gerrit-Reviewer: Dbrant <[email protected]> Gerrit-Reviewer: Deskana <[email protected]> Gerrit-Reviewer: Mholloway <[email protected]> Gerrit-Reviewer: Niedzielski <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
