Update Android build instructions

sandialabs · Jul 3, 2024 · bf02f93 · bf02f93
1 parent 5be3b9d
commit bf02f93
Showing 1 changed file with 5 additions and 106 deletions.
diff --git a/target/android/README.md b/target/android/README.md
@@ -1,119 +1,18 @@
-Building for Android is a pain; you have to make sure the same compiler, flags,
-runtime, etc are used for boost, Wt, and InterSpec (or at least that everything
-is abi compatible) - if not, things might still compile, but randomly crash.  
-And of course the boost build system is bjam, while Wt and InterSpec is CMake, 
-and as it is now, InterSpec is being built by Android Studio, while Wt is from 
-the command line.  Further, for the life of me I couldnt get CMake to actually
-find boost and Wt libraries for android, even when I specified all the 
-directories I could. I was unable to find an elegant way to do all this, so I 
-just brute forced it.
-These instructions are for March of 2022, and macOS was used.
+To build for Android we will take advantage of the CMake `FetchContent` style build of InterSpec to build boost and Wt for us.
 
-- Download and install Android Studio (2021.1.1 Patch 2 was used).
-- Then use the HelloJNI example project to determine which compile flags is used
- by cmake/Android-Studio.
-  - Build each architecture you might want, and then in like
-    AndroidStudioProjects/HelloJNI/app/.cxx/cmake/arm8Debug/armeabi-v7a/compile_commands.json
-    you can get the actual compile flags.
-- Then use https://github.com/moritz-wundke/Boost-for-Android to build boost
-  - Boost-for-Android is great, but you really need to check that it uses
-    the same build settings as CMake will.  To do this edit the
-    configs/user-config-boost-1_65_1-common.jam and
-    configs/user-config-boost-1_65_1-{target}.jam target files that come with
-    Boost-for-Androidso to the compile flags match the ones extracted from
-    HelloJNI.  You need to do this for each architecture.
-  - Also, you may need to edit build-android.sh to allow using NDK version 17
-    (using same settings as 16)
-  - run `./build-android.sh --boost=1.78.0 --arch=armeabi-v7a,arm64-v8a,x86,x86_64 --prefix=/Users/wcjohns/install/android/ /Users/wcjohns/Library/Android/sdk/ndk/23.1.7779620/`
-- Then compile Wt 3.7.1.
-
-patch -u src/Wt/Render/CssParser.C -i ${PATCH_DIR}/wt/3.7.1/CssParser.C.patch
-
-  - Manually build Wt for each architecture
-    - ```bash
-      mkdir build_android_armeabi-v7a;cd build_android_armeabi-v7a`
-
-      export MY_ANDROID_ABI="armeabi-v7a"
-    
-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=${MY_WT_PREFIX} -DBoost_INCLUDE_DIR=${MY_WT_PREFIX}/include -DBOOST_PREFIX=${MY_WT_PREFIX} -DSHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX=${MY_WT_PREFIX} -DHARU_PREFIX=${MY_WT_PREFIX} -DHARU_LIB=${MY_WT_PREFIX}/lib/libhpdfs.a -DENABLE_SSL=OFF  -DENABLE_MYSQL=OFF -DENABLE_POSTGRES=OFF -DENABLE_PANGO=OFF -DINSTALL_FINDWT_CMAKE_FILE=ON  -DCONFIGDIR=${MY_WT_PREFIX}/etc/wt -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" ..
-
-
-      export MY_BOOST_DIR="/Users/wcjohns/install/android/armeabi-v7a"
-      cmake -DANDROID_SDK_DIR=/Users/wcjohns/Library/Android/sdk \
-            -DANDROID_NDK_TOOLS_DIR=/Users/wcjohns/Library/Android/sdk/tools \
-            -DANDROID_STAGING_DIR=${MY_BOOST_DIR} \
-            -DCMAKE_BUILD_TYPE=Release \
-            -DCMAKE_PREFIX_PATH=${MY_BOOST_DIR} \
-            -DANDROID_NDK=/Users/wcjohns/Library/Android/sdk/ndk/23.1.7779620/ \
-            -DCMAKE_CXX_FLAGS=-std=c++14 \
-            -DCMAKE_TOOLCHAIN_FILE=/Users/wcjohns/Library/Android/sdk/ndk/23.1.7779620/build/cmake/android.toolchain.cmake \
-            -DSHARED_LIBS=OFF -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=OFF -DWT_CPP_11_MODE='-std=c++14' \
-            -DENABLE_SSL=OFF -DHTTP_WITH_ZLIB=OFF \
-            -DCONFIGURATION=data/config/wt_config_android.xml \
-            -DWTHTTP_CONFIGURATION=data/config/wthttpd \
-            -DCMAKE_INSTALL_PREFIX=${MY_BOOST_DIR} \
-            -DBoost_INCLUDE_DIR=${MY_BOOST_DIR}/include/boost-1_78 \
-
-I dont think we need below here
--DANDROID_CPP_FEATURES=rtti exceptions -DANDROID_TOOLCHAIN=clang -DANDROID_PIE=ON \
-            -DBoost_DATE_TIME_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_date_time-clang-darwin-mt-1_65_1.a \
-            -DBoost_FILESYSTEM_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_filesystem-clang-darwin-mt-1_65_1.a \
-            -DBoost_PROGRAM_OPTIONS_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_program_options-clang-darwin-mt-1_65_1.a \
-            -DBoost_RANDOM_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_random-clang-darwin-mt-1_65_1.a \
-            -DBoost_REGEX_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_regex-clang-darwin-mt-1_65_1.a \
-            -DBoost_SIGNALS_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_signals-clang-darwin-mt-1_65_1.a \
-            -DBoost_SYSTEM_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_system-clang-darwin-mt-1_65_1.a \
-            -DBoost_THREAD_LIBRARY_RELEASE=${MY_BOOST_DIR}/lib/libboost_thread-clang-darwin-mt-1_65_1.a \
-            ..
-      make -j8
-      make install
-      ```
-      And of course you probably want to do this for the other architectures:
-      ```bash
-      export MY_ANDROID_ABI="arm64-v8a"
-      export MY_BOOST_DIR="/Users/wcjohns/install/android/${MY_ANDROID_ABI}"
-      cmake ...
-      ```
-
-      ```
-      export MY_ANDROID_ABI="x86"
-      export MY_BOOST_DIR="/Users/wcjohns/install/android/${MY_ANDROID_ABI}"
-      cmake ...
-      ```
-
-      ```
-      export MY_ANDROID_ABI="x86_64"
-      export MY_BOOST_DIR="/Users/wcjohns/install/android/${MY_ANDROID_ABI}"
-      cmake ...
-      ```
-
-    - However at this point libwt.a is like 700 MB, and doesnt have the correct 
-      headers, so you have to run:
-      ```bash
-      ${NDK_ROOT}/toolchains/arm-linux-androideabi-4.9/prebuilt/darwin-x86_64/bin/arm-linux-androideabi-strip --strip-debug libwt.a`
-      ```
-      and 
-      ```
-      ${NDK_ROOT}/toolchains/arm-linux-androideabi-4.9/prebuilt/darwin-x86_64/bin/arm-linux-androideabi-ranlib libwt.a
-      ```
-      But of course you will have to do this for each Wt library, and architecture 
-      (make sure to use the correct ranlib and strip for each architecture though).
-      You might also have to run ranlib over the boost libraries.
+So you should just need to:
 - Open `InterSpec/target/android/InterSpec` in Android Studio, and adjust paths
-   in the gradle build files; I wouldnt be suprisedif you had to adjust the main 
+   in the gradle build files; I wouldnt be suprised if you had to adjust the main 
    InterSpec CMakeLists.txt too.
-- Update the files such as `data`, `InterSpec_resources`, `resources`, and 
-  `example_data` by putting them into a zip file 
-  `InterSpec/target/android/InterSpec/app/src/main/assets/interspec-assets.zip`
-  using `target/android/InterSpec/make_assets.sh`
+- The first build will take ~30 minutes to clone into boost, and Wt, and other dependancies, as well as patch and build them.
 - Android Studio tends to be extremely slow and unresponsive (like hours to do an operation - maybe because of the amount of NDK building?), so
    building and loading to device from the command line tends to be much quicker.
    - ```bash
      cd target/android/InterSpec
      export JAVA_HOME="/Applications/Android Studio.app/Contents/jbr/Contents/Home/"
      ./gradlew assembleUniversal
      ./gradlew installUniversalRelease
-     #or to make iterating a little faster (min of1.5 minutes instead of 5 minutes), use just the ARM release
+     #or to make iterating a little faster (min of 1.5 minutes instead of 5 minutes), use just the ARM release
      ./gradlew assembleArm7 && ./gradlew installArm7Release
      ```
 - Good luck building things...