Skip to content

Commit 6a807bd

Browse files
committed
docs: update CONTRIBUTING for baosp-tts rename
1 parent 6c19a9e commit 6a807bd

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to aotts
1+
# Contributing to baosp-tts
22

3-
Thank you for contributing to aotts, the SVOX Pico TTS engine built for BAOSP.
3+
Thank you for contributing to baosp-tts, the SVOX Pico TTS engine built for BAOSP.
44
This guide is written to work well with screen readers and keyboard-only navigation.
55
Every step is numbered and linear — no visual layout is assumed.
66

@@ -60,10 +60,10 @@ You need:
6060

6161
## About this project
6262

63-
aotts wraps the SVOX Pico TTS library (written in C) as an Android TTS engine.
64-
The project has two main parts:
63+
baosp-tts wraps the SVOX Pico TTS library (written in C) as an Android TTS engine.
64+
The project has three main parts:
6565

66-
- `src/main/java/`Kotlin/Java wrapper that registers as an Android TTS engine
66+
- `src/main/java/` — Java wrapper that registers as an Android TTS engine
6767
- `src/main/cpp/` — C code for SVOX Pico (downloaded during build, not committed)
6868
- `src/main/assets/lang/` — Language data files (also downloaded during build)
6969

@@ -76,10 +76,10 @@ For local builds you need to download them yourself — see Step 4 below.
7676

7777
Forking makes a personal copy of the code under your own GitHub account.
7878

79-
1. Open github.com/tech-master33/aotts
79+
1. Open github.com/tech-master33/baosp-tts
8080
2. Activate the Fork button near the top of the page
8181
3. On the next screen, activate Create fork
82-
4. GitHub takes you to your copy at github.com/YOUR-USERNAME/aotts
82+
4. GitHub takes you to your copy at github.com/YOUR-USERNAME/baosp-tts
8383

8484
---
8585

@@ -89,9 +89,9 @@ Open a terminal and run these commands one at a time.
8989
Replace YOUR-USERNAME with your actual GitHub username.
9090

9191
```bash
92-
git clone https://github.com/YOUR-USERNAME/aotts.git
93-
cd aotts
94-
git remote add upstream https://github.com/tech-master33/aotts.git
92+
git clone https://github.com/YOUR-USERNAME/baosp-tts.git
93+
cd baosp-tts
94+
git remote add upstream https://github.com/tech-master33/baosp-tts.git
9595
```
9696

9797
Running `git remote -v` should now show both `origin` (your fork) and `upstream` (the main repo).
@@ -172,29 +172,29 @@ Every change must follow these rules:
172172

173173
```bash
174174
chmod +x gradlew
175-
./gradlew assembleDebug
175+
./gradlew assembleDebug -Pandroid.ndkVersion=23.1.7779620
176176
```
177177

178178
The APK will be at:
179179

180180
```
181-
build/outputs/apk/debug/aotts-debug.apk
181+
build/outputs/apk/debug/
182182
```
183183

184184
To install it on a connected Android device:
185185

186186
```bash
187-
adb install build/outputs/apk/debug/aotts-debug.apk
187+
adb install build/outputs/apk/debug/*.apk
188188
```
189189

190-
After installing, go to Settings → Accessibility → Text-to-speech output and select aotts as the engine.
190+
After installing, go to Settings → Language & input → Text-to-speech output and select BAOSP TTS as the engine.
191191

192192
### Manual testing checklist
193193

194194
Go through each item before submitting your pull request:
195195

196196
- The app builds without errors or warnings (including the NDK build)
197-
- aotts appears in the TTS engine list in Android Settings
197+
- baosp-tts appears in the TTS engine list in Android Settings
198198
- All six languages (English US, English GB, German, Spanish, French, Italian) produce speech
199199
- Speech rate and pitch controls in Settings take effect immediately
200200
- The engine does not crash or produce silence on long strings
@@ -235,7 +235,7 @@ git push origin your-branch-name
235235

236236
Then:
237237

238-
1. Open github.com/YOUR-USERNAME/aotts
238+
1. Open github.com/YOUR-USERNAME/baosp-tts
239239
2. GitHub shows a bar saying your branch was recently pushed
240240
3. Activate Compare and pull request
241241
4. Fill in the title: one sentence describing the change
@@ -248,7 +248,7 @@ Then:
248248

249249
You do not need to know how to code to do this. It is one of the most valuable contributions.
250250

251-
1. Open github.com/tech-master33/aotts/issues
251+
1. Open github.com/tech-master33/baosp-tts/issues
252252
2. Activate New issue
253253
3. Choose Bug report or Feature request
254254
4. Fill in the title with one short sentence describing the problem or request
@@ -277,9 +277,9 @@ If you have not heard back after a week, add a comment to the pull request to as
277277

278278
## Community and questions
279279

280-
- Discussions: github.com/tech-master33/aotts/discussions
281-
- Issues: github.com/tech-master33/aotts/issues
282-
- Screen reader: github.com/tech-master33/andrdscren
280+
- Discussions: github.com/tech-master33/baosp-tts/discussions
281+
- Issues: github.com/tech-master33/baosp-tts/issues
282+
- Screen reader: github.com/tech-master33/baosp-screenreader
283283
- Launcher: github.com/tech-master33/aoler
284284
- BAOSP main project: github.com/tech-master33/baosp
285285

0 commit comments

Comments
 (0)