Changes made to the readme files to fix links to documentation site.

blackberry · Apr 9, 2015 · c337bf7 · c337bf7
1 parent d27ab0a
commit c337bf7
Show file tree

Hide file tree

Showing 24 changed files with 55 additions and 54 deletions.
diff --git a/Accelerometer/readme.txt b/Accelerometer/readme.txt
@@ -9,7 +9,7 @@ Sample Description:
  When you run the application, the value of the pitch and roll of the device is
  printed to the console, and updated every 25 milliseconds.
 
- Feature summary
+ Feature summary:
  - Handling navigator events
  - Handling accelerometer updates
 

diff --git a/AdSample/readme.txt b/AdSample/readme.txt
@@ -5,8 +5,9 @@
 
   The Ads sample illustrates how to incorporate advertisements to your application.
 
-  Details of this feature can be found at http://developer.blackberry.com/native/documentation/bb10/ad_service_intro.html
-  Feature summary
+  Details of this feature can be found at http://developer.blackberry.com/native/documentation/device_platform/advertising/index.html
+
+  Feature summary:
 	- Creating ad banners
 	- Displaying an advertisement in a browser when a user taps on the banner
 
@@ -21,12 +22,12 @@
   ========================================================================
   Importing a project into the Native SDK:
 
-  1.	From the Sample apps page, download and extract the sample application.
-  2.	To launch the QNX Momentics IDE, from the Start menu, click on BlackBerry Native SDK.
-  3.	From the File menu, click Import.
-  4.	Expand General, and select Existing Projects into Workspace. Click Next.
-  5.	Browse to the location where you saved your sample app, and then click OK. The sample project should be displayed in the Projects section.
-  6.	Click Finish to import the project into your workspace. 
-  7.	In the Project Explorer pane, right-click NativeSampleAdSDK and depending on whether you are deploying to a device or simulator, select either    		Device-Debug, Device-Release or Simulator-Debug. 
-  8.	In the Project Explorer pane, right-click NativeSampleAdSDK and select Run As > BlackBerry C/C++ Application.
+  1. From the Sample apps page, download and extract the sample application.
+  2. To launch the QNX Momentics IDE, from the Start menu, click on BlackBerry Native SDK.
+  3. From the File menu, click Import.
+  4. Expand General, and select Existing Projects into Workspace. Click Next.
+  5. Browse to the location where you saved your sample app, and then click OK. The sample project should be displayed in the Projects section.
+  6. Click Finish to import the project into your workspace. 
+  7. In the Project Explorer pane, right-click NativeSampleAdSDK and depending on whether you are deploying to a device or simulator, select either Device-Debug, Device-Release or Simulator-Debug. 
+  8. In the Project Explorer pane, right-click NativeSampleAdSDK and select Run As > BlackBerry C/C++ Application.
 
diff --git a/AudioControl/readme.txt b/AudioControl/readme.txt
@@ -11,7 +11,7 @@ Sample Description:
  When you run the application, you can change one of the properties of the audio
  mixer and the updated audio mixer status is printed to the console.
 
- Feature summary
+ Feature summary:
  - Handling audio mixer events
  - Querying the audio mixer service
 

diff --git a/BelligerentBlocks/README.txt b/BelligerentBlocks/README.txt
@@ -6,7 +6,7 @@ Sample Description:
  Belligerent Blocks is a 1 level game created as part of a presentation
  made at DevCon.
 
- Feature summary
+ Feature summary:
  - Rendering 2D graphics
  - Rendering text
  - Using Scoreloop's social platform

diff --git a/Camera/README.md b/Camera/README.md
@@ -2,14 +2,14 @@
 
 The Camera sample is a simple application for taking pictures.
 
-In this sample, you will learn:
-
-* how to access the camera
-* how to start the viewfinder and acquire the corresponding viewfinder window handle
-* how to take a photo (non-blocking)
-* how to save a photo to the camera roll
-* how to pass argument data between the main thread and your callback threads
-* how to wake up your main thread using user-defined bps events from your callback threads
+In this sample, you will learn how to:
+
+* Access the camera
+* Start the viewfinder and acquire the corresponding viewfinder window handle
+* Take a photo (non-blocking)
+* Save a photo to the camera roll
+* Pass argument data between the main thread and your callback threads
+* Wake up your main thread using user-defined bps events from your callback threads
 
 When the app is launched, you will see the camera viewfinder window.
 Tap anywhere on the screen to take a photo.
diff --git a/Channels/readme.txt b/Channels/readme.txt
@@ -8,8 +8,8 @@ Sample Description:
 
  We retrieve and display geolocation specific information, such as the latitude,
  longitude, altitude, and bearing of the device from the default channel of the
- main thread.  This thread also listens for the navigator's event telling it to
- exit.  Before joining on the child thread, it sends a custom event to the child
+ main thread. This thread also listens for the navigator's event telling it to
+ exit. Before joining on the child thread, it sends a custom event to the child
  thread's channel letting it know that it should exit.
 
  We retrieve and display the x, y and z values of the accelerometer of the
@@ -18,7 +18,7 @@ Sample Description:
  When the application is executed, geolocation data is displayed in a dialog and
  accelerometer data is displayed in another.
 
- Feature summary
+ Feature summary:
  - Requesting events from different channels
  - Multiple dialogs
 

diff --git a/CubeRotate/readme.txt b/CubeRotate/readme.txt
@@ -9,7 +9,7 @@ Sample Description:
  When you run the application, the application displays a cube that rotates on
  the screen.
 
- Feature summary
+ Feature summary:
  - Initializing EGL and setting up your screen
  - Creating a 3D rotating cube using OpenGL ES
  - Rendering the graphics on the screen

diff --git a/Dialog/readme.txt b/Dialog/readme.txt
@@ -15,7 +15,7 @@ Sample Description:
  dialog by swiping down from the top of the screen. An alert dialog is a simple
  dialog that contains a title, message, and buttons.
 
- Feature summary
+ Feature summary:
  - Handling dialog events
  - Creating and displaying a dialog
  - Setting the properties of a dialog

diff --git a/FallingBlocks/readme.txt b/FallingBlocks/readme.txt
@@ -4,15 +4,15 @@ FallingBlocks
 Sample Description:
 
  The Falling Blocks example is a simple application that displays moving colored
- blocks on the screen.  The blocks always move towards the side of the device
- that is angled down, and once they reach the edge of the screen, they wrap
+ blocks on the screen. The blocks always move towards the side of the device
+ that is angled down. Once they reach the edge of the screen, they wrap
  around and start again from the opposite edge. As you rotate or turn the
  device, the blocks change direction to reflect the new orientation.
 
  Each time you tap the screen, a new block is rendered in the location that you
  touched, which then starts moving along with the rest of the blocks.
 
- Feature summary
+ Feature summary:
  - Handling screen, navigator, and sensor events
  - Rendering objects on the screen
 

diff --git a/Gamepad/readme.txt b/Gamepad/readme.txt
@@ -4,7 +4,7 @@ Gamepad - Handle and configure game controller events
 Sample Description:
 
 The Gamepad sample is an application that demonstrates how to handle
-gamepad and joystick events.  It can handle two connected game controllers
+gamepad and joystick events. It can handle two connected game controllers
 at once.
 
 When an HID game controller is connected to the device, a collection of

diff --git a/Geolocation/readme.txt b/Geolocation/readme.txt
@@ -9,7 +9,7 @@ Sample Description:
 
  When you run the application, geolocation data is displayed in a dialog.
 
- Feature summary
+ Feature summary:
  - Handling a geolocation response
  - Initializing the screen to set the window group Id
  - Requesting dialog events

diff --git a/Gesture/readme.txt b/Gesture/readme.txt
@@ -10,7 +10,7 @@ Sample Description:
  the gesture used, such as tap, double-tap, and pinch. Information about the
  gestures are also output to the debug console.
 
- Feature summary
+ Feature summary:
  - Handling screen gestures
 
 ========================================================================

diff --git a/GoodCitizen/readme.txt b/GoodCitizen/readme.txt
@@ -7,10 +7,10 @@ Sample Description:
  number of common development practices that you can use in your own
  applications.
 
- When you run the application, the application displays a spinning cube that you
+ When you run the application, it displays a spinning cube that you
  can change the color of by selecting different menu options.
 
- Feature summary
+ Feature summary:
  - Display a 3D cube that responds to a light source
  - Load textures and render text on the screen
  - Handle orientation changes and touch events

diff --git a/HelloWorldDisplay/readme.txt b/HelloWorldDisplay/readme.txt
@@ -9,7 +9,7 @@ Sample Description:
  When you run the application, a customized "Hello World" message is displayed
  on the screen.
 
- Feature summary
+ Feature summary:
  - Loading a default font
  - Querying the width and height of the window surface
  - Initializing EGL for 2D rendering

diff --git a/HttpProxy/readme.txt b/HttpProxy/readme.txt
@@ -6,10 +6,10 @@ Sample Description:
  The HTTP Proxy sample is an application that is designed to retrieve the proxy
  information of the device that was set by the user.
 
- When you run the application, the application queries the device for the proxy
+ When you run the application, it queries the device for the proxy
  information and uses libcurl to retrieve a URL.
 
- Feature summary
+ Feature summary:
  - Querying HTTP proxy information
  - Using libcurl to load a webpage with that information.
 

diff --git a/Keyboard/readme.txt b/Keyboard/readme.txt
@@ -9,7 +9,7 @@ Sample Description:
  When you run the application, different behaviors are triggered depending on
  the key that is pressed. The key presses are also output to the debug console.
 
- Feature summary
+ Feature summary:
  - Handling virtual keyboard events
 
 ========================================================================

diff --git a/LocaleSample/readme.txt b/LocaleSample/readme.txt
@@ -6,10 +6,10 @@ Sample Description:
  The Locale sample is an application that is designed to show you how to
  retrieve locale information from the device.
 
- When you run the application, the application queries the device for the
+ When you run the application, it queries the device for the
  current locale, and prints the country and language to the console.
 
- Feature summary
+ Feature summary:
  - Handling navigator events
  - Responding to locale changes
 

diff --git a/NetworkStatus/readme.txt b/NetworkStatus/readme.txt
@@ -6,11 +6,11 @@ Sample Description:
  The Network Status sample is an application that is designed to retrieve the
  network status of the device.
 
- When you run the application, the application queries the device for the
+ When you run the application, it queries the device for the
  network status, prints the status to the console, and listens for changes to
  the status.
 
- Feature summary
+ Feature summary:
  - Handling navigator events
  - Responding to network status changes
 

diff --git a/PaymentService/readme.txt b/PaymentService/readme.txt
@@ -9,13 +9,13 @@ Sample Description:
  register digital goods in the vendor portal for BlackBerry App World and allow
  users to purchase these digital goods in your applications.
 
- When you run the application it starts with the simulation of a purchase
- already initiated.  Once you're done, you can simulate another purchase by 
+ When you run the application, it starts with the simulation of a purchase
+ already initiated. Once you're done, you can simulate another purchase by 
  swiping down from the top of the screen. The simulated purchase request is 
  performed in local mode, meaning that no information is sent to the Payment 
  Service server and a simulated purchase response is received.
 
- Feature summary
+ Feature summary:
  - Creating purchase parameters
  - Making a purchase request
  - Handling purchase responses

diff --git a/PlayAudio/readme.txt b/PlayAudio/readme.txt
@@ -10,7 +10,7 @@ Sample Description:
  When you run the application, a sample MP3 file is played. The volume and mute
  status is adjusted during playback.
 
- Feature summary
+ Feature summary:
  - Connecting and configuring the multimedia renderer
  - Configuring audio input and output
  - Starting and stopping audio playback

diff --git a/PlayWav/readme.txt b/PlayWav/readme.txt
@@ -8,7 +8,7 @@ Sample Description:
 
  When you run the application, a sample WAV file is played.
 
- Feature summary
+ Feature summary:
  - Opening a sound file
  - Determining the properties of a sound file
  - Preparing a sound file for playback

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ All APIs shared in this repository are Open Source under the  [Apache 2.0 Licens
 
 ## Code Organization
 
-Each Sample added to the repository should be placed in its own directory.  Make sure you name the directory something simple, yet descriptive.  Each Sample must also have a README file at the root of its directory.
+Each Sample added to the repository should be placed in its own directory. Make sure you name the directory something simple, yet descriptive. Each Sample must also have a README file at the root of its directory.
 
 ## Contributing Samples
 

diff --git a/VideoPlayback/readme.txt b/VideoPlayback/readme.txt
@@ -8,7 +8,7 @@ Sample Description:
 
  When you run the application, a video is played on the screen.
 
- Feature summary
+ Feature summary:
  - Creating a playback window
  - Connecting and configuring the renderer
  - Configuring video input and output

diff --git a/VideoWindow/readme.txt b/VideoWindow/readme.txt
@@ -11,15 +11,15 @@ Sample Description:
  pressed.
 
  When the button is pressed, the play button turns into a blue stop symbol and
- video playback begins.  While the video is playing, the user can chose to stop
- the video by tapping the blue symbol.  The blue stop symbol will then turn into
- a green play symbol.  When the green symbol is pressed, playback will continue.
+ video playback begins. While the video is playing, the user can chose to stop
+ the video by tapping the blue symbol. The blue stop symbol will then turn into
+ a green play symbol. When the green symbol is pressed, playback will continue.
 
  The user may swipe from the top of the bevel into the video (down-swipe) in
- order to hide the symbol.  This is achieved by changing the z-order of the
+ order to hide the symbol. This is achieved by changing the z-order of the
  mmrender video surface.
 
- Feature summary
+ Feature summary:
  - Creating a playback window
  - Connecting and configuring the renderer
  - Configuring video input and output