Skip to content

Commit

Permalink
docs(README): explain split builds/other tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Rexogamer committed Nov 12, 2023
1 parent 4413a1d commit 8182f76
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# RVMob

<a href="https://translate.revolt.chat/engage/rvmorb/">
<img src="https://translate.revolt.chat/widgets/rvmorb/-/app/svg-badge.svg" alt="Translation status" />
</a>

**RVMob** is a mobile Revolt client made in React Native.

**Please note that RVMob is currently in beta.** It is exclusive to Android and contains several bugs/incomplete features - use at your own discretion.

For development updates and other news, join [RVMob's support server](https://rvlt.gg/YW312HPF).
For development updates and other news, join [RVMob's support server][support-server].

## Installing

If you want to install RVMob, simply go to [the releases tab](https://github.com/revoltchat/rvmob/releases) and download the latest version. We plan on publishing RVMob to app stores in the future.

Debug builds are also produced for every commit. These are unoptimised - they're much larger and noticeably slower than the release builds, but you can try out new features early.

Also note that, from v0.7.0, RVMob's APKs are **split by architecture**. This helps to reduce file sizes - however, you'll need to make sure that you **download the APK that matches your device's architecture**, or **it won't install!**
### Info about split builds

Also note that, from v0.7.0, RVMob's APKs are **split by architecture**. This helps to reduce file and app sizes - however, you'll need to make sure that you **download the APK that matches your device's architecture**, or **it won't install!**

If you're using an app store, this should be handled for you. If not, however, you'll need to check your device's architecture. I'd recommend using [Treble Info](https://gitlab.com/TrebleInfo/TrebleInfo/-/blob/dev/README.md) for this. Install and open the app - **don't worry about what it says on the home page!** - then open the Details tab and check the CPU architecture entry.

Depending on what it says:
- if it says `ARM64`, you'll want the APK with **`arm64-v8a`** in its file name;
- if it says `ARM32`, you'll want the APK with **`armeabi-v7a`** in its file name;
- if it says `x86_64`, you'll want the APK with **`x86_64`** in its file name;
- and if it says `x86`, you'll want the APK with **`x86` but without `64`** in its file name.

If it says `Unknown`, please ask for help in [our support server][support-server]


## Building

Expand All @@ -30,6 +47,7 @@ yarn install
npx rn-nodeify -e
npx react-native-asset
yarn android # for the android app
yarn start
```

CLI commands:
Expand All @@ -52,4 +70,6 @@ If you're still experiencing issues, and there aren't any open issues for the bu

## License

RVMob is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/rvmob/blob/master/LICENSE).
RVMob is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/rvmob/blob/master/LICENSE).

[support-server]: https://rvlt.gg/rvmob

0 comments on commit 8182f76

Please sign in to comment.