Skip to content
Browse files

README.md changes

  • Loading branch information...
1 parent 9be832c commit 3fc161f9dc84800ef3984167f9a499b8baa62e9b Adam Wilson committed
View
8 README.md
@@ -1,4 +1,4 @@
-![android.jpg](https://github.com/orbotix/Sphero-Android-SDK/raw/master/android.jpg)
+![android.jpg](https://github.com/orbotix/Sphero-Android-SDK/raw/master/assets/image001.jpg)
# Android Developer Quick Start Guide
@@ -36,20 +36,20 @@ When creating a new project it is important to take special notice to the Androi
Place the libs folder from the SDK into your Android project's folder.
- ![QSG-libs.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/QSG-libs.png)
+ ![QSG-libs.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/assets/image002.png)
### Setting the dependency to RobotLibrary.jar.
Set the dependency in the project's properties in the Properties->Java Build Path-> Libraries dialog. This will allow your project access to all the public method names in RobotLibrary.jar.
- ![QSG-jar-depend.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/QSG-jar-depend.png)
+ ![QSG-jar-depend.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/assets/image003.png)
### Adding the RobotUILibrary source library into the workspace.
Import the library into workspace using Import->General->Existing projects
into Workspace. You can have the importer copy the source into your workspace folder or you can place it into the workspace folder before importing. Once it is imported, you need to set the project dependent on RobotLibrary.jar, which is added using the Properties->Java Build ->Libraries dialog. You will need to add RobotUILibrary as library project to your application project from the projects Properties dialog.
- ![QSG-library-project.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/QSG-library-project.png)
+ ![QSG-library-project.png](https://github.com/orbotix/Sphero-Android-SDK/raw/master/assets/image004.png)
RobotUILibrary is distributed as source, so you can customize the look of the resources to fit in with your applications.
View
0 android.jpg → assets/image001.jpg
File renamed without changes
View
0 QSG-libs.png → assets/image002.png
File renamed without changes
View
0 QSG-jar-depend.png → assets/image003.png
File renamed without changes
View
0 QSG-library-project.png → assets/image004.png
File renamed without changes
View
12 samples/AchievementSample/README.md
@@ -14,18 +14,18 @@ There is an achievement sample code project in the dev center that has an exampl
Click on the “Dev” link in the top right corner of SpheroWorld after you are logged in to create a new application for your app. The same application can be used for both Android and iOS applications.
-![image01.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/image01.png)
+![image01.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/assets/image001.png)
### Add achievements to your Sphero World application (Universal)
Once your application has been created you can add achievements by clicking on the achievements tap when viewing the application details. You can then click the “add achievement” button to add an achievement.
-![yadda.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/yadda.png)
+![yadda.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/assets/image002.png)
After clicking **Add Achievement** you will see this screen:
-![newache.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/newache.png)
+![newache.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/assets/image003.png)
@@ -53,7 +53,7 @@ After clicking **Add Achievement** you will see this screen:
The first step when integrating your iOS application with any part of Sphero World is to be sure you are setting your app id and app secret when your application first launches. You can find these two pieces of information by viewing your application while logged into SpheroWorld.
-![catball.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/catball.png)
+![catball.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/assets/image004.png)
In the *applicaiton:didFinishLaunchingWithOptions:* method inside of the application delegate of your iOS application you will need to set the application id and secret before using any Sphero World functionality. It is easiest to ensure this happens by making it your first line of code. **You will need to be sure to import RobotKit.h in your app delegate.** See example below:
@@ -138,7 +138,7 @@ When the notification fires you can extract the RKAchievement object the user ea
The first step to integrate your application with SpheroWorld is to pass in your applicaion id and secret string (*obtained from SpheroWorld as shown below*) when your main activity starts before you make any calls to RobotLibrary.
-![catball.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/catball.png)
+![catball.png](https://github.com/orbotix/Sphero-iOS-SDK/raw/master/samples/AchievementSample/assets/image004.png)
An example of setting up the Achievement Manager is shown below.
@@ -189,4 +189,4 @@ This example shows how achievements with complex threshold conditions can be tra
### Notifying the user of earned achievements
-You can listen for the AchievementManager.AchievementEarnedIntent so you can notify the player when the user has earned an achievement. A JSON string containing the achievement meta data can be found as a string extra attached to the intent under the key “achievementJSON”. Currently RobotLibrary on Android doesn’t provide a UI to notify users they earned an achievement.
+You can listen for the AchievementManager.AchievementEarnedIntent so you can notify the player when the user has earned an achievement. A JSON string containing the achievement meta data can be found as a string extra attached to the intent under the key “achievementJSON”. Currently RobotLibrary on Android doesn’t provide a UI to notify users they earned an achievement.
View
BIN samples/AchievementSample/catball.png
Deleted file not rendered
View
BIN samples/AchievementSample/image01.png
Deleted file not rendered
View
BIN samples/AchievementSample/newache.png
Deleted file not rendered
View
BIN samples/AchievementSample/yadda.png
Deleted file not rendered
View
2 samples/ButtonDrive/README.md
@@ -1,6 +1,6 @@
# ButtonDrive
-![Screen Shot](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/ButtonDrive/README.png)
+![Screen Shot](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/ButtonDrive/assets/image001.png)
This code sample demonstrates driving a Sphero by sending roll commands at 0°, 90°, 180°, and 270°. The roll command
takes a heading from 0° to 360°, and a relative speed from 0.0 to 1.0. So, to command the ball to go 90° at half speed would be:
View
0 samples/ButtonDrive/README.png → samples/ButtonDrive/assets/image001.png
File renamed without changes
View
8 samples/UISample/README.md
@@ -3,7 +3,7 @@
The ColorPickerActivity presents a color wheel and a brightness bar along with a couple preview windows and an RGB readout. This is a very easy way for a user to change the color of their Sphero™.
-![Color Picker](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/colorPicker.png)
+![Color Picker](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/assets/image001.png)
The color changes initiated by the user are then broadcast to provide access to anything registered to receive them.
@@ -70,7 +70,7 @@ startActivityForResult(colorPickerIntent, REQUEST_CHANGE_COLOR);
The calibration view can be used to give the user some visual feedback while "aiming" their Sphero. It is meant to be an "all in one" widget combining the rotation gesture detection with the visual representation of calibration while sending the commands to Sphero to actually rotate and calibrate when finished.
-![Calibration View](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/calibration_view.png)
+![Calibration View](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/assets/image002.png)
To use this widget, simply add it to your layout, set it up when you create your activity, and set the robot you would like to control when it is available.
@@ -117,7 +117,7 @@ The joystick view is just one of the ways a user can control Sphero. One of the
The `JoystickView` is also meant to be an "all in one" view. Once setup with a `Robot` object to control, the `JoystickView` takes care of the rest. If you would like more information on how the joystick works or you would like to implement your own joystick using some more advanced techniques, check out our DriveControl explanation.
-![SpheroCam Joystick](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/joystick.jpg)
+![SpheroCam Joystick](https://github.com/orbotix/Sphero-Android-SDK/raw/master/samples/UISample/assets/image003.jpg)
The joystick can be added to your Activity's layout with something similar to the following.
@@ -132,4 +132,4 @@ The joystick can be added to your Activity's layout with something similar to th
app:alpha="0.7"/>
```
-You can adjust the size of the entire joystick using the `layout_width` and `layout_height` attributes. To control the size of the joystick's puck, use the `puck_radius` attribute. `alpha` adjusts the opacity of the joystick control (the higher the value, the more opaque the control). Once you connect (typically in the `StartupActivity`) and obtain a Robot object (usually done in the `onActivityResult(int, int, Intent)` method when returning from the StartupActivity), you can use the JoystickView's `setRobot(Robot)` method to activate the joystick and to begin controlling Sphero.
+You can adjust the size of the entire joystick using the `layout_width` and `layout_height` attributes. To control the size of the joystick's puck, use the `puck_radius` attribute. `alpha` adjusts the opacity of the joystick control (the higher the value, the more opaque the control). Once you connect (typically in the `StartupActivity`) and obtain a Robot object (usually done in the `onActivityResult(int, int, Intent)` method when returning from the StartupActivity), you can use the JoystickView's `setRobot(Robot)` method to activate the joystick and to begin controlling Sphero.
View
0 samples/UISample/colorPicker.png → samples/UISample/assets/image001.png
File renamed without changes
View
0 samples/UISample/calibration_view.png → samples/UISample/assets/image002.png
File renamed without changes
View
0 samples/UISample/joystick.jpg → samples/UISample/assets/image003.jpg
File renamed without changes

0 comments on commit 3fc161f

Please sign in to comment.
Something went wrong with that request. Please try again.