Skip to content

Commit ac474e7

Browse files
committed
Rename MainActivity to RwMainActivity in Andriod Manifest, added more details to readme, updating SDK and build-tools.
1 parent e9e750c commit ac474e7

File tree

3 files changed

+47
-19
lines changed

3 files changed

+47
-19
lines changed

README.md

+43-15
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,36 @@
11
# Roundware® for Android
22

3-
## Roundware® Overview
3+
## Roundware Overview
44

5-
Roundware® is a flexible distributed framework which collects, stores, organizes
5+
Roundware is a flexible distributed framework which collects, stores, organizes
66
and re-presents audio content. Basically, it lets you collect audio from anyone
77
with a smartphone or web access, upload it to a central repository along with
88
its metadata and then filter it and play it back collectively in continuous
99
audio streams.
1010

1111
For more information about Roundware® functionality and projects that use the
12-
platform, please check out: [roundware.org](http://www.roundware.org "Roundware®")
12+
platform, please see: [roundware.org](http://www.roundware.org "Roundware")
1313

14-
## Creating your own Roundware® Android App
14+
## Creating your own Roundware Android App
1515

1616
### Summary
17-
Your App and namespace wraps the available Roundware® App functionality allowing
18-
customization of existing Java Classes and Resources such as drawables and XML.
17+
Starting with a copy of the `starter-app` directory, your App wraps the
18+
available Roundware App functionality allowing customization of existing Java
19+
Classes and Resources such as drawables and XML.
20+
1921

2022
### Getting Started
2123

2224
Prerequisites:
23-
* A working Roundware® Server installation.
25+
* A working Roundware Server installation.
2426
* Knowledge of Android Mobile Application development with Android Studio
2527

2628
Setup the codebase:
2729
```bash
2830
# Clone the codebase
2931
git clone https://github.com/roundware/roundware-android.git
3032
cd roundware-android
31-
# Copy the starter app
33+
# Copy "starter app" to "app"
3234
cp -R app-starter app
3335
cd app
3436
# Make your copy into a git repository
@@ -44,14 +46,40 @@ git push origin master
4446
Configure the project:
4547

4648
* Open the project in Android Studio
47-
* Edit `app/AndroidManifest.xml` to set your namespace.
48-
* Edit `app/src/main/res/values/rwconfig.xml` to set your server and project ID.
49+
* Edit `app/src/main/AndroidManifest.xml` to set your namespace. Change:
50+
```xml
51+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
52+
package="org.roundware.app_starter">
53+
```
54+
55+
To:
56+
```xml
57+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
58+
package="com.example.rw">
59+
```
60+
61+
* Edit `app/build.gradle` to set your namespace. Change:
62+
```
63+
defaultConfig {
64+
applicationId "org.roundware.app_starter"
65+
```
66+
67+
To:
68+
```
69+
defaultConfig {
70+
applicationId "com.example.rw"
71+
```
72+
73+
* Edit `app/src/main/res/values/rwconfig.xml` to set your server and project ID.
4974
* Edit `app/src/main/res/values/strings.xml` to set your application name.
5075
* Edit `app/src/main/res/values/api_keys.xml` to set your Google Maps API Key.
76+
* Run 'app' to try your new Roundware app with the provided configuration.
5177

52-
Any files you copy from the `rwapp` and `rwservice` Modules into your `app`
53-
project will override the original versions during project build. Add the new
54-
values if the XML file already exists.
55-
56-
TODO: More details...
78+
### To infinity and beyond
5779

80+
* Any files you copy from the `rwapp` and `rwservice` modules into your `app`
81+
project will override the original versions during project build.
82+
* Add the new values if the XML file already exists.
83+
* It should be possible to make the majority of needed changes without ever
84+
modifying a file outside of the `app` directory. If not, please file an issue
85+
on the issue queue.

app-starter/build.gradle

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
apply plugin: 'com.android.application'
22

33
android {
4-
compileSdkVersion 21
5-
buildToolsVersion "21.1.2"
4+
compileSdkVersion 22
5+
buildToolsVersion "22.0.1"
66

77
defaultConfig {
88
applicationId "org.roundware.app_starter"
99
minSdkVersion 9
10-
targetSdkVersion 21
10+
targetSdkVersion 22
1111
versionCode 1
1212
versionName "1.0"
1313
}

app-starter/src/main/AndroidManifest.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<application android:label="@string/app_name"
55
android:allowBackup="true">
6-
<activity android:name=".MainActivity"
6+
<activity android:name="org.roundware.rwapp.RwMainActivity"
77
android:label="@string/app_name"
88
android:configChanges="keyboardHidden|orientation|screenSize"
99
android:screenOrientation="portrait">

0 commit comments

Comments
 (0)