diff --git a/README.md b/README.md index bbeca21c..5c183a0c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # secant-android-wallet -_Note: As of September 2021, this is a brand new project. Since it is being developed in the open from the beginning, initially this project will not be fully functional. Some of the documentation below will be aspirational until the implementation is further along. During this initial stage of development, the older [Zcash Android Wallet](https://github.com/zcash/zcash-android-wallet) may be a more helpful sample._ +_Note: This is a new and unreleased project. Since it is being developed in the open from the beginning, initially this project will not be fully functional. Some of the documentation below will be aspirational until the implementation is further along. During this initial stage of development, the older [Zcash Android Wallet](https://github.com/zcash/zcash-android-wallet) may be a more helpful sample._ This is a sample implementation of a Zcash wallet for Android leveraging the [Zcash Android SDK](https://github.com/zcash/zcash-android-wallet-sdk). The goal is to exercise the SDK and related Zcash libraries, as well as demonstrate how the SDK works. diff --git a/docs/Setup.md b/docs/Setup.md index f639b2f0..a68054fe 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -14,7 +14,7 @@ Start by making sure the command line with Gradle works first, because **all the 1. Install JVM 11 or greater on your system. Our setup has been tested with Java 11-17. Although a variety of JVM distributions are available and should work, we have settled on recommending [Adoptium/Temurin](https://adoptium.net), because this is the default distribution used by Gradle toolchains. For Windows or Linux, be sure that the `JAVA_HOME` environment variable points to the right Java version. Note: If you switch from a newer to an older JVM version, you may see an error like the following `> com.android.ide.common.signing.KeytoolException: Failed to read key AndroidDebugKey from store "~/.android/debug.keystore": Integrity check failed: java.security.NoSuchAlgorithmException: Algorithm HmacPBESHA256 not available`. A solution is to delete the debug keystore and allow it to be re-generated. 1. Android Studio has an embedded JVM, although running Gradle tasks from the command line requires a separate JVM to be installed. Our Gradle scripts are configured to use toolchains to automatically install the correct JVM version. 1. Install Android Studio and the Android SDK - 1. Download [Android Studio](https://developer.android.com/studio/). We typically use the stable version of Android Studio, unless specifically noted due to short-term known issues. Note that due to issue #420 Intel-based machines may have trouble building in Android Studio. The workaround is to add the following line to `~/.gradle/gradle.properties` `ZCASH_IS_DEPENDENCY_LOCKING_ENABLED=false`. + 1. Download [Android Studio](https://developer.android.com/studio/preview). As of September 2022, we recommend Android Studio Electric Eel preview because it is more robust with Kotlin Multiplatform. Also note that due to issue #420 Intel-based machines may have trouble building in Android Studio. If you experience this, the workaround is to add the following line to `~/.gradle/gradle.properties` `ZCASH_IS_DEPENDENCY_LOCKING_ENABLED=false`. 1. During the Android Studio setup wizard, choose the "Standard" setup option 1. Note the file path where Android Studio will install the Android developer tools, as you will need this path later 1. Continue and let Android Studio download and install the rest of the Android developer tools