Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ The app supports multiple OBA server deployments. Region configuration:

## White-Label / Branding

The app supports white-labeling via Gradle product flavors. See `REBRANDING.md` for full documentation.
The app supports white-labeling via Gradle product flavors. See `docs/REBRANDING.md` for full documentation.

### Branded String Pattern
Strings containing the app name use `%1$s` placeholders that are replaced at runtime:
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,44 @@ OneBusAway for Android provides:
5. The ability to search for nearby stops or routes
6. Real-time multimodal trip planning, using real-time transit and bike share information (requires a regional [OpenTripPlanner](https://www.opentripplanner.org/) server)
7. Bike share map layer, which includes real-time availability information for floating bikes and bike rack capacity (requires a regional [OpenTripPlanner](https://www.opentripplanner.org/) server)
8. Issue reporting to any Open311-compliant issue management system (see [this page](ISSUE_REPORTING.md) for details)
8. Issue reporting to any Open311-compliant issue management system (see [this page](docs/ISSUE_REPORTING.md) for details)

OneBusAway for Android automatically keeps track of your most used stops and routes, and allows you to put shortcuts on your phone's home screen for any stop or route you choose.

## Alpha and Beta Testing

Get early access to new OneBusAway Android versions, and help us squash bugs! See our [Testing Guide](https://github.com/OneBusAway/onebusaway-android/blob/main/BETA_TESTING.md) for details.
Get early access to new OneBusAway Android versions, and help us squash bugs! See our [Testing Guide](docs/BETA_TESTING.md) for details.

## Build Setup

Want to build the project yourself and test some changes? See our [build documentation](BUILD.md).
Want to build the project yourself and test some changes? See our [build documentation](docs/BUILD.md).

## Contributing

We welcome contributions to the project! Please see our [Contributing Guide](https://github.com/OneBusAway/onebusaway-android/blob/main/.github/CONTRIBUTING.md) for details, including Code Style Guidelines.

## System Architecture

Curious what servers power certain features in OneBusAway Android? Check out the [System Architecture page](SYSTEM_ARCHITECTURE.md).
Curious what servers power certain features in OneBusAway Android? Check out the [System Architecture page](docs/SYSTEM_ARCHITECTURE.md).

## Deploying OneBusAway Android in Your City

There are two ways to deploy OneBusAway Android in your city:

1. **Join the OneBusAway [multi-region project](https://github.com/OneBusAway/onebusaway/wiki/Multi-Region)** - The easiest way to get started - simply set up your own OneBusAway server with your own transit data, and get added to the OneBusAway apps! See [this page](https://github.com/OneBusAway/onebusaway/wiki/Multi-Region) for details.
2. **Deploy a rebranded version of OneBusAway Android as your own app on Google Play** - Requires a bit more maintenance, but it allows you to set up your own app on Google Play based on the OneBusAway Android source code. See [rebranding page](https://github.com/OneBusAway/onebusaway-android/blob/main/REBRANDING.md) for details.
2. **Deploy a rebranded version of OneBusAway Android as your own app on Google Play** - Requires a bit more maintenance, but it allows you to set up your own app on Google Play based on the OneBusAway Android source code. See [rebranding page](docs/REBRANDING.md) for details.

## Testing Your Own OneBusAway/OpenTripPlanner servers

Did you just set up your own [OneBusAway](https://github.com/OneBusAway/onebusaway-application-modules/wiki) and/or [OpenTripPlanner](https://www.opentripplanner.org/) server? You can test both in this app without compiling any Android code. Just download the app from [Google Play](https://play.google.com/store/apps/details?id=com.joulespersecond.seattlebusbot), and see our [Custom Server Setup Guide](CUSTOM_SERVERS.md) for details.
Did you just set up your own [OneBusAway](https://github.com/OneBusAway/onebusaway-application-modules/wiki) and/or [OpenTripPlanner](https://www.opentripplanner.org/) server? You can test both in this app without compiling any Android code. Just download the app from [Google Play](https://play.google.com/store/apps/details?id=com.joulespersecond.seattlebusbot), and see our [Custom Server Setup Guide](docs/CUSTOM_SERVERS.md) for details.

## Permissions

In order to support certain features in OneBusAway, we need to request various permissions to access information on your device. See an explanation of why each permission is needed [here](PRIVACY.md).

## Troubleshooting

Things not going well building the project? See our [Troubleshooting](TROUBLESHOOTING.md) section. If you're a user of the app, check out our [FAQ](FAQ.md).
Things not going well building the project? See our [Troubleshooting](docs/TROUBLESHOOTING.md) section. If you're a user of the app, check out our [FAQ](docs/FAQ.md).

## OneBusAway Project

Expand Down
2 changes: 1 addition & 1 deletion BETA_TESTING.md → docs/BETA_TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ You can also reach us via:
* Email - android-app (at) onebusaway.org
* Posting a messsage to the [OneBusAway Google+ Community](https://plus.google.com/u/0/communities/105092615216731099521)
* Posting a messsage on the [onebusaway-developers Google Group](https://groups.google.com/forum/#!forum/onebusaway-developers)
* Filing a issue on the [OBA Android Github issue tracker](https://github.com/OneBusAway/onebusaway-android/blob/main/CONTRIBUTING.md#issue-tracker)
* Filing a issue on the [OBA Android Github issue tracker](../.github/CONTRIBUTING.md#issue-tracker)
4 changes: 2 additions & 2 deletions BUILD.md → docs/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This results in a total of 1 * 3 = 3 core build variants. Each of these core va

The below instructions assume you're going to be building for the **google** platform flavor and original **oba** brand by default (e.g., `obaGoogleDebug`).

If you want more info about building the other brands, please see the [Rebranding OneBusAway Android page](https://github.com/OneBusAway/onebusaway-android/blob/main/REBRANDING.md).
If you want more info about building the other brands, please see the [Rebranding OneBusAway Android page](REBRANDING.md).

### Prerequisites for both Android Studio and Gradle

Expand All @@ -27,7 +27,7 @@ If you want more info about building the other brands, please see the [Rebrandin

1. Download, install, and run the latest version of [Android Studio](http://developer.android.com/sdk/installing/studio.html).
1. At the welcome screen select `Import Project`, browse to the location of this repository and select it then select Ok.
1. Open the Android SDK Manager (Tools->Android->SDK Manager) and add a checkmark for the necessary API level (see `compileSdk` in [`onebusaway-android/build.gradle.kts`](onebusaway-android/build.gradle.kts)) then select OK.
1. Open the Android SDK Manager (Tools->Android->SDK Manager) and add a checkmark for the necessary API level (see `compileSdk` in [`onebusaway-android/build.gradle.kts`](../onebusaway-android/build.gradle.kts)) then select OK.
1. Connect a [debugging enabled](https://developer.android.com/tools/device.html) Android device to your computer or setup an Android Virtual Device (Tools->Andorid->AVD Manager).
1. Open the "Build Variants" window (it appears as a vertical button on left side of workspace by default) & choose **obaGoogleDebug** to select the Google Play version.
1. Click the green play button (or Alt+Shift+F10) to build and run the project!
Expand Down
2 changes: 1 addition & 1 deletion CUSTOM_SERVERS.md → docs/CUSTOM_SERVERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ server. After entering the server name and path, hit the back button twice to e

We strongly encourage you to configure your server to use SSL for secure communication via HTTPS - this is required for launching as a new region in the Regions API due to requirements in Android and iOS.

If you want to test a server without SSL enabled, you'll need to build your own version of this app with an edited [`onebusaway-android/src/main/res/xml/network_security_config.xml`](onebusaway-android/src/main/res/xml/network_security_config.xml) file to add an exception for your server. This is an Android restriction for plain text HTTP communication - see https://developer.android.com/training/articles/security-config for details.
If you want to test a server without SSL enabled, you'll need to build your own version of this app with an edited [`onebusaway-android/src/main/res/xml/network_security_config.xml`](../onebusaway-android/src/main/res/xml/network_security_config.xml) file to add an exception for your server. This is an Android restriction for plain text HTTP communication - see https://developer.android.com/training/articles/security-config for details.

### OneBusAway API Server

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion FAQ.md → docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Please be sure to tap on the star next to the stop name, not the route name (see

### Why does OneBusAway Android need photo and other permissions?

See the [Permissions explained](PERMISSIONS.md) page.
See the [Permissions explained](../PRIVACY.md) page.

### I can see bus stops on the map, but the map itself is gray with no street names. What's going on?

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion TROUBLESHOOTING.md → docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Open the Android SDK Manager and make sure the following are installed:
* Android SDK Tools
* Android SDK Platform-tools
* Android SDK Build-tools
* Under the currently used SDK version (see `compileSdkVersion` in [`onebusaway-android/build.gradle`](onebusaway-android/build.gradle))
* Under the currently used SDK version (see `compileSdk` in [`onebusaway-android/build.gradle.kts`](../onebusaway-android/build.gradle.kts))
* SDK Platform
* Google APIs
* Extras
Expand Down
2 changes: 1 addition & 1 deletion onebusaway-android/flavors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Use [Android Asset Studio](http://romannurik.github.io/AndroidAssetStudio/icons-

### Step 4: Add Firebase Configuration (Optional)

Add your app's Firebase client info to `google-services.json`. See `REBRANDING.md` for detailed instructions.
Add your app's Firebase client info to `google-services.json`. See `docs/REBRANDING.md` for detailed instructions.

**Note on API key security:** Firebase API keys in `google-services.json` are safe to commit to version control. Unlike server-side API keys, these client-side keys are designed to be embedded in apps and are protected by:
- Package name restrictions (the key only works for your specific app ID)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
* Loads previously recorded trips (GPS data) and replays them through the NavigationServiceProvider
* via the NavigationSimulation class.
*
* <p>For creating new test methods - see the file DESTINATION_REMINDERS.md
* <p>For creating new test methods - see the file docs/DESTINATION_REMINDERS.md
*/
@RunWith(AndroidJUnit4.class)
public class NavigationTest extends ObaTestCase {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import org.onebusaway.android.R
*
* Colors are read via [colorResource] instead of being duplicated as Kotlin constants so there is
* a single source of truth: night mode switches automatically with the resource configuration,
* and white-label brand flavors that override colors.xml (see REBRANDING.md) are respected
* and white-label brand flavors that override colors.xml (see docs/REBRANDING.md) are respected
* without any Compose-side changes. Slots not defined in colors.xml fall back to the Material 3
* baseline for the current light/dark mode.
*/
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.