RomanNum3ral
/
for-android
mirror of https://github.com/stoatchat/for-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improvements to documentation for smoother dev onboarding 

This commit makes several changes:
1. Fixes broken links in README file
2. Adds a note to the README file about mandatory configuration
3. Fixes the dev container trying to copy a non-existent file

Signed-off-by: Misofist <misofist@heavendivided.net>
This commit is contained in:
Misofist 2026-02-15 03:54:42 +11:00
parent 75bb23982b
commit 9c2c5b3d98
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.devcontainer/devcontainer.json
View File

@ -10,7 +10,7 @@
"jdkDistro": "oracle"
}
},
"postCreateCommand": "chmod +x gradlew && deno run -A scripts/download_deps.ts --yes && cp revoltbuild.properties.example revoltbuild.properties && cp sentry.properties.example sentry.properties && cp app/google-services.json.example app/google-services.json && git submodule update --init --recursive",
"postCreateCommand": "chmod +x gradlew && deno run -A scripts/download_deps.ts --yes && cp stoatbuild.properties.example stoatbuild.properties && cp sentry.properties.example sentry.properties && cp app/google-services.json.example app/google-services.json && git submodule update --init --recursive",
"customizations": {
"vscode": {
"extensions": [

21
README.md
View File

@ -30,23 +30,28 @@ uses [Jetpack Compose](https://developer.android.com/jetpack/compose).
### Stoat for Android
- [Roadmap](https://op.revolt.wtf/projects/revolt-for-android/work_packages)
- [Stoat for Android Technical Documentation](https://revoltchat.github.io/android/)
- [Android-specific Contribution Guide](https://revoltchat.github.io/android/contributing/guidelines/)
- [Roadmap](https://op.stoatinternal.com/projects/revolt-for-android/work_packages)
- [Stoat for Android Technical Documentation](https://stoatchat.github.io/for-android/)
- [Android-specific Contribution Guide](https://stoatchat.github.io/for-android/contributing/guidelines/)
&mdash;**read carefully before contributing!**
### Stoat
- [Stoat Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests
- [Stoat Project Board](https://github.com/orgs/stoatchat/discussions) (Submit feature requests
here)
- [Stoat Development Server](https://app.revolt.chat/invite/API)
- [Stoat Server](https://app.revolt.chat/invite/Testers)
- [General Stoat Contribution Guide](https://developers.revolt.chat/contrib.html)
- [General Stoat Contribution Guide](https://developers.stoat.chat/developing/contrib/)
## Quick Start
Open the project in Android Studio. You can then run the app on an emulator or a physical device by
running the `app` module.
1. Open the project in Android Studio.
2. Copy `stoatbuild.properties.example`, `sentry.properties.example`, and
`app/google-services.json.example`. The new filenames should have the
".example" suffix removed.
3. Fill out the three new files.
4. Run the app on an emulator or a physical device by
running the `app` module.
In-depth setup instructions can be found
at [Setting up your Development Environment](https://revoltchat.github.io/android/contributing/setup/)
at [Setting up your Development Environment](https://stoatchat.github.io/for-android/contributing/setup/)