From c129252da56743e734b6e67167a00ea12d598acd Mon Sep 17 00:00:00 2001 From: - <-> Date: Tue, 3 Dec 2024 22:56:43 +0100 Subject: [PATCH] chore: update readme installation instruction --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b356722..3e9a921 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,24 @@ A no-bullshit, pure Monero wallet suitable for both newcomers and experienced users. Originally forked from the Monerujo codebase, it has been entirely rewritten on the Java side into Kotlin. The monerujo.cpp C++ file still exists but has been updated/modified. -Project was initially started by pokkst, and is now maintained by anoncontributorxmr. +Project was initially started by pokkst, and is now maintained by anoncontributorxmr. ## QUICKSTART -Note: there are no production releases of mysu available yet. Only proceed if you would like to use a beta/testing release. +Note: there are no production releases of mysu available yet. Only proceed if you would like to use a beta/testing release. -- Download the most current release [here](https://codeberg.org/anoncontributorxmr/mysu/actions) (click on the latest green action for `master` branch and look for "apks" artifact there). Unzip the archive and install the APK. +- Download the latest release [here](https://codeberg.org/anoncontributorxmr/mysu/actions) + - Click on the newest action that is successful (has a green tick to the left) and originates from the `master` branch (has a label with the same name to the right). + - If the action has a label different than `master` - this is a work in progress release not intended for general audience, proceed only if you know what you are doing. + - Look for `apks` artifact and click on it (this will start the download of a zip file). + - Unzip the archive, find the app (it has .apk extension) and install it on your device. - Run the app, enter a passphrase (optional, depending on seed type), recovery seed (optional), and restore height (optional) to create a wallet. - See the [FAQ](doc/FAQ.md) ## Disclaimer Be sure to back up your wallet recovery phrase (and seed offset/passphrase, if you set one. Mysu enforces seed offsets/passphrases for Polyseed wallets). -We are NOT responsible for lost or stolen funds. +We are NOT responsible for lost or stolen funds. ## Notable Features - Tor and I2P support (no built-in daemons though) @@ -26,24 +30,24 @@ We are NOT responsible for lost or stolen funds. ## HOW TO BUILD See [the instructions](doc/BUILDING-external-libs.md) -Then, fire up Android Studio and build the APK like any other android app. +Then, fire up Android Studio and build the APK like any other android app. ## Donations ### pokkst -pokkst is the original author of mysu. +pokkst is the original author of mysu. -XMR address: `87BqQYkugEzh6Tuyotm2uc3DzJzKM6MuZaC161e6u1TsQxxPmXVPHpdNRyK47JY4d1hhbe25YVz4e9vTXCLDxvHkRXEAeBC` +XMR address: `87BqQYkugEzh6Tuyotm2uc3DzJzKM6MuZaC161e6u1TsQxxPmXVPHpdNRyK47JY4d1hhbe25YVz4e9vTXCLDxvHkRXEAeBC` ### anoncontributorxmr -anoncontributorxmr is the current maintainer of mysu. +anoncontributorxmr is the current maintainer of mysu. -XMR address: `48KqWkaWd8KcJKkakWfknJEo16scc8YkycfKpb8JYchiKJfukY1ompX9eQ9n3CfEBU1ADGj3P5FLAb731J2UghQt142LwHQ` +XMR address: `48KqWkaWd8KcJKkakWfknJEo16scc8YkycfKpb8JYchiKJfukY1ompX9eQ9n3CfEBU1ADGj3P5FLAb731J2UghQt142LwHQ` #### Expenses (excluding developer time) -Maintaining mysu incurs some costs, so please consider donating to the address above. +Maintaining mysu incurs some costs, so please consider donating to the address above. - Build server for CI/CD: 10 EUR / month