Skip to content

Commit 57ff042

Browse files
committed
Update README.md
Provide instructions on how to import project properly. Much trial and error Such google Many stackoverflow
1 parent 49712ec commit 57ff042

File tree

1 file changed

+51
-19
lines changed

1 file changed

+51
-19
lines changed

README.md

+51-19
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Initially started by the Wikimedia Foundation, this app is now maintained by vol
66

77
## Build Requirements ##
88

9-
1. [Android SDK][1] (Level 22)
9+
1. [Android SDK][1] (Level 23)
1010
2. [Maven][2]
1111

1212
## Build Instructions ##
@@ -21,27 +21,59 @@ Initially started by the Wikimedia Foundation, this app is now maintained by vol
2121

2222
### Import and Compile Commons Android App ##
2323

24-
[Download IntelliJ][6] or [Download Android Studio][7]. (Note: The steps below currently only work on Android Studio 1.5 and below)
24+
[Download IntelliJ][6] or [Download Android Studio 1.5.2][7]. (Note: The steps below currently only work on Android Studio 1.5.2 and below)
2525

2626
1. Clone the repository.
27-
2. Open IntelliJ/Android Studio. Ensure Maven integration plugin is enabled (File > Settings > Plugins > Maven integration).
27+
2. Open IntelliJ/Android Studio. Tick the box for the Maven Integration plugin by selecting:
28+
``File`` > ``Settings`` > ``Plugins`` > ``Maven Integration``
29+
or
30+
(From Quick Start menu): ``Configure`` > ``Plugins`` > ``Maven Integration``
2831
3. Import Project:
29-
File -> Import Project
32+
``File`` > ``Import Project``
3033
or
31-
Select 'Import Project' from the Quick Start menu
32-
4. Navigate to the folder with the cloned repository and press 'OK'.
33-
5. Select 'Import Project from external model' -> 'Maven' and press 'Next'.
34-
6. Make sure 'Search for projects recursively' and 'Import Maven projects automatically' are checked. Select 'Next'.
35-
7. This section needs no modification. Select 'Next'.
36-
8. This section needs no modification. Select 'Next'.
37-
9. Make sure the 'Android SDK home path' points to the 'android-sdk' folder. If the dropdown next to 'Java SDK' is empty, hit the '+' button avobe the sidebar and select 'JDK'. Navigate to your jdk folder, select it, and hit 'OK'. Now select the newly added JDK and hit 'Next'.
38-
10. This section needs no modifications. Select 'Next'.
39-
11. Select 'Finish'.
40-
12. After the program opens select 'Make project' - there should be errors.
41-
13. Near the top of the file that is opened up, one of the offending lines should be "import android.support.v4.app.FragmentActivity;" - put your cursor on that line and hit 'alt'/'option'+'enter' to bring up the AutoFix dialog. Select the 'compatibility' option.
42-
14. File -> Project Structure -> Project and ensure the Project SDK is set to at least API 23. This is required for DocumentsContract to work.
43-
15. File -> Project Structure -> Modules and select 'commons'. Select the 'Dependencies' tab and click the green '+' button. Select 'JARs or directories' and navigate to the 'lib' folder. Select all the .jars in that folder and click 'OK'. This imports the QuadTree and GSON libraries.
44-
16. Select 'Make project' again. It should compile successfully.
34+
(From Quick Start menu): ``Import Project (Eclipse ADT, Gradle, etc.)``
35+
4. Navigate to the folder with the cloned repository (named apps-android-commons). Select ``OK``.
36+
5. Select ``Import Project from external model`` > ``Maven``. Select ``Next``.
37+
6. Tick the boxes ``Search for projects recursively`` and ``Import Maven projects automatically``. Select ``Next``.
38+
7. Select ``Next``.
39+
8. Select ``Next``.
40+
9. Click ``Maven Android API 23 Platform`` or ``Android API 23 Platform`` in the sidebar. Make sure the ``Android SDK home path`` points to the ``/Android/Sdk`` folder. Make sure the ``Java SDK`` is set to 1.8 or higher.
41+
If there are no options for the ``Java SDK``, click the ``+`` button above the sidebar and select 'JDK'. Navigate to your JDK folder, select it, and hit ``OK``, and then select the newly added JDK.
42+
Select ``Next``.
43+
10. Select ``Next``.
44+
11. Select ``Finish``.
45+
12. Use Javac 1.8. To do this, navigate to:
46+
``File`` > ``Settings`` > ``Build, Execution, Deployment`` > ``Compiler`` > ``Java Compiler``.
47+
Then enter these settings:
48+
``Use compiler: Javac``
49+
``Project bytecode version (leave blank for JDK default)`` (leave blank)
50+
``Per-module bytecode versionn`` - for both (``commons`` and ``commons-parent``) remove the preset value. It should change to ``JDK default``.
51+
Select ``OK``.
52+
13. Reset the SDK. To do this, navigate to:
53+
``File`` > ``Project Structure`` > ``Project Settings`` > ``Project``.
54+
Set the ``Project SDK`` to ``Maven Android API 23 Platform`` or ``Android API 23 Platform``.
55+
14. Set the language levels. On the sidebar go to ``Project Settings`` > ``Modules``.
56+
Select the ``Sources`` tab on the right pane
57+
Go through ``commons``, ``commons-parent``, ``~apklib-com.actionbarsherlock_actionbarsherlock_4.4.0``, and ``~apklib-com.viewpagerindicator_library_2.4.1``. For all of them set ``Language level`` to ``Project default (8 - Lambdas, type annotations etc.)``
58+
15. Set the Module SDKs.
59+
Select the ``Dependencies`` tab on the right pane.
60+
Set the modules as follows:
61+
62+
| Name | Module SDK |
63+
|-------------------------------------------------------|---------------------------------------|
64+
| commons | Project SDK (Android API 23 Platform) |
65+
| commons-parent | Project SDK (Android API 23 Platform) |
66+
| ~apklib-com.actionbarsherlock_actionbarsherlock_4.4.0 | Maven Android API 14 Platform |
67+
| ~apklib-com.viewpagerindicator_library_2.4.1 | Maven Android API 16 Platform |
68+
69+
If these modules are not available, install the correct API levels through the SDK manager. To do this do the following:
70+
71+
* Click ``Cancel``. Navigate to ``File`` > ``Settings`` > ``Appearance & Behaviour`` > ``System Settings`` > ``Android SDK``.
72+
* Tick the boxes for API levels ``14``, ``16``, and ``23`` (or Android ``4.0``, ``4.1.2`` and ``6.0``).
73+
* Then click ``OK``, and allow it to download the new APIs. Once it has finished, click ``File`` > ``Project Structure`` > ``Project Settings`` > ``Modules``, and repeat step 15.
74+
16. Select ``commons``. Click the green ``+`` button on the right. Select ``JARs or directories...``. Choose the ``apps-android-commons/lib`` folder. Select ``OK``.
75+
17. Select ``OK`` to save your changes to the project structre settings.
76+
18. To test it worked, check if it builds (Select ``commons`` on the projects panel. Select ``Build`` > ``Make Module 'commons'``). If there are no errors (warnings are OK) you're set!
4577

4678
## License ##
4779

@@ -98,4 +130,4 @@ Thumbnail images are not currently cached. (?)
98130
[4]: http://search.maven.org/
99131
[5]: https://www.apache.org/licenses/LICENSE-2.0
100132
[6]: http://www.jetbrains.com/idea/download/index.html
101-
[7]: http://developer.android.com/sdk/index.html
133+
[7]: https://sites.google.com/a/android.com/tools/download/studio/builds/1-5-2

0 commit comments

Comments
 (0)