1
1
# Roundware® for Android
2
2
3
- ## Roundware® Overview
3
+ ## Roundware Overview
4
4
5
- Roundware® is a flexible distributed framework which collects, stores, organizes
5
+ Roundware is a flexible distributed framework which collects, stores, organizes
6
6
and re-presents audio content. Basically, it lets you collect audio from anyone
7
7
with a smartphone or web access, upload it to a central repository along with
8
8
its metadata and then filter it and play it back collectively in continuous
9
9
audio streams.
10
10
11
11
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 ")
13
13
14
- ## Creating your own Roundware® Android App
14
+ ## Creating your own Roundware Android App
15
15
16
16
### 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
+
19
21
20
22
### Getting Started
21
23
22
24
Prerequisites:
23
- * A working Roundware® Server installation.
25
+ * A working Roundware Server installation.
24
26
* Knowledge of Android Mobile Application development with Android Studio
25
27
26
28
Setup the codebase:
27
29
``` bash
28
30
# Clone the codebase
29
31
git clone https://github.com/roundware/roundware-android.git
30
32
cd roundware-android
31
- # Copy the starter app
33
+ # Copy " starter app" to "app"
32
34
cp -R app-starter app
33
35
cd app
34
36
# Make your copy into a git repository
@@ -44,14 +46,40 @@ git push origin master
44
46
Configure the project:
45
47
46
48
* 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.
49
74
* Edit ` app/src/main/res/values/strings.xml ` to set your application name.
50
75
* 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.
51
77
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
57
79
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.
0 commit comments