Skip to content

Commit d026332

Browse files
author
Misofist
committed
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>
1 parent 75bb239 commit d026332

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"jdkDistro": "oracle"
1111
}
1212
},
13-
"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",
13+
"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",
1414
"customizations": {
1515
"vscode": {
1616
"extensions": [

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,23 +30,28 @@ uses [Jetpack Compose](https://developer.android.com/jetpack/compose).
3030

3131
### Stoat for Android
3232

33-
- [Roadmap](https://op.revolt.wtf/projects/revolt-for-android/work_packages)
34-
- [Stoat for Android Technical Documentation](https://revoltchat.github.io/android/)
35-
- [Android-specific Contribution Guide](https://revoltchat.github.io/android/contributing/guidelines/)
33+
- [Roadmap](https://op.stoatinternal.com/projects/revolt-for-android/work_packages)
34+
- [Stoat for Android Technical Documentation](https://stoatchat.github.io/for-android/)
35+
- [Android-specific Contribution Guide](https://stoatchat.github.io/for-android/contributing/guidelines/)
3636
&mdash;**read carefully before contributing!**
3737

3838
### Stoat
3939

40-
- [Stoat Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests
40+
- [Stoat Project Board](https://github.com/orgs/stoatchat/discussions) (Submit feature requests
4141
here)
4242
- [Stoat Development Server](https://app.revolt.chat/invite/API)
4343
- [Stoat Server](https://app.revolt.chat/invite/Testers)
44-
- [General Stoat Contribution Guide](https://developers.revolt.chat/contrib.html)
44+
- [General Stoat Contribution Guide](https://developers.stoat.chat/developing/contrib/)
4545

4646
## Quick Start
4747

48-
Open the project in Android Studio. You can then run the app on an emulator or a physical device by
49-
running the `app` module.
48+
1. Open the project in Android Studio.
49+
2. Copy `stoatbuild.properties.example`, `sentry.properties.example`, and
50+
`app/google-services.json.example`. The new filenames should have the
51+
".example" suffix removed.
52+
3. Fill out the three new files.
53+
4. Run the app on an emulator or a physical device by
54+
running the `app` module.
5055

5156
In-depth setup instructions can be found
52-
at [Setting up your Development Environment](https://revoltchat.github.io/android/contributing/setup/)
57+
at [Setting up your Development Environment](https://stoatchat.github.io/for-android/contributing/setup/)

0 commit comments

Comments
 (0)