Standardize README.md formatting and add some missing descriptions.

mcowart123 · Sep 27, 2011 · 62a4153 · 62a4153
1 parent 5edfb21
commit 62a4153
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 58 deletions.
diff --git a/AVCaptureFrames/README.md b/AVCaptureFrames/README.md
@@ -9,14 +9,14 @@ How to capture video frames from the camera as images using AV Foundation
 http://developer.apple.com/library/ios/#qa/qa1702/_index.html
 
 Requires
-========
+--------
 
 iOS 4.0 and up.
 This example will only run correctly on a iOS device, this requires
 a purchased version of MonoTouch.
 
 License
-=======
+-------
 
 The samples are licensed under the MIT X11 license:
 
@@ -39,6 +39,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/AVTouchSample/README.md b/AVTouchSample/README.md
@@ -8,6 +8,6 @@ Based on Apple's avTouch example:
 http://developer.apple.com/library/ios/#samplecode/avTouch/Introduction/Intro.html
 
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/AppPrefs/README.md b/AppPrefs/README.md
@@ -1,14 +1,12 @@
 AppPrefs
-===========================
-
-Preview
-=======
+========
 
 An example how to diesplay application preferences in the "Settings" system application.
 
 Loosely based on Apple's AppPrefs example:
 http://developer.apple.com/library/ios/#samplecode/AppPrefs
 
 Authors
-=======
-Mike Krüger
+-------
+
+Mike Krüger
diff --git a/CoreTelephonyDemo/README.md b/CoreTelephonyDemo/README.md
@@ -1,13 +1,12 @@
 Core Telephony Demo
-=============
+===================
 
-Description
------------
 An example showing how to access the users's current call, call center and carrier information.
 
 Based on the Apple sample:
 https://developer.apple.com/library/ios/#samplecode/CoreTelephonyDemo/Introduction/Intro.html
 
 Authors
 -------
+
 Rolf Bjarne Kvinge
diff --git a/GLPaint-GameView/README.md b/GLPaint-GameView/README.md
@@ -1,20 +1,18 @@
 OpenGL Paint using GameView
 ===========================
 
-TODO
-
-Preview
-=======
-
-![iPhone running GLPaint sample](http://farm7.static.flickr.com/6143/5999004778_b2801d14e2.jpg)
-
 An example on using the iPhoneOSGameView class with OpenGL
 to create a touch painting application.
 
 Loosely based on Apple's GLPaint example:
 http://developer.apple.com/library/ios/#samplecode/GLPaint/Introduction/Intro.html
 
+Preview
+-------
+
+![iPhone running GLPaint sample](http://farm7.static.flickr.com/6143/5999004778_b2801d14e2.jpg)
+
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/Keychain/README.md b/Keychain/README.md
@@ -1,4 +1,4 @@
 Keychain
 ========
 
-TODO
+This sample demonstrates simple interaction with the iOS keychain.
diff --git a/LowLevelGLPaint/README.md b/LowLevelGLPaint/README.md
@@ -1,20 +1,18 @@
 OpenGL Paint using Low Level OpenGL
 ===================================
 
-TODO
-
-Preview
-=======
-
-![iPhone running GLPaint sample](http://farm7.static.flickr.com/6143/5999004778_b2801d14e2.jpg)
-
 An example on using the low level OpenGL classes
 to create a touch painting application.
 
 Loosely based on Apple's GLPaint example:
 http://developer.apple.com/library/ios/#samplecode/GLPaint/Introduction/Intro.html
 
+Preview
+-------
+
+![iPhone running GLPaint sample](http://farm7.static.flickr.com/6143/5999004778_b2801d14e2.jpg)
+
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/MonoCatalog-MonoDevelop/README.md b/MonoCatalog-MonoDevelop/README.md
@@ -5,9 +5,10 @@ A kitchen sink example of common UI elements and APIs used in iOS and how you ca
 
 Preview
 -------
+
 ![iPhone running MonoCatalog](http://farm7.static.flickr.com/6020/5999694606_bc1acdb573.jpg)
 
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/MonoDevelopTouchCells/README.md b/MonoDevelopTouchCells/README.md
@@ -5,9 +5,10 @@ An example showing using the a UITableView and displaying a custom cell within i
 
 Preview
 -------
+
 ![iPhone running MonoDevelop TouchCells](http://farm7.static.flickr.com/6013/5999235933_dcab80c0a3.jpg)
 
 Authors
-=======
+-------
 
 Miguel de Icaza
diff --git a/Popovers/README.md b/Popovers/README.md
@@ -1,25 +1,23 @@
 Popovers
-
-================================================================================
-ABSTRACT:
+========
 
 This sample demonstrates proper use of UIPopoverController in iOS.
 UIPopoverController presentation, dismissing, and rotation handling are covered.
 The sample is provided using a UISplitViewController in order to show proper handling of UIPopoverControllers being presented from UIBarButtonItems.
 Additional handling ensures that multiple UIPopoverControllers are never presented at the same time.
 
-================================================================================
-BUILD REQUIREMENTS:
+Build Requirements
+------------------
 
 iOS 4.1 or later
 
-================================================================================
-RUNTIME REQUIREMENTS:
+Runtime Requirements
+--------------------
 
 iOS 3.2 or later
 
-================================================================================
-PACKAGING LIST:
+Packaging List
+--------------
 
 PopoversAppDelegate
 The application delegate sets up the initial view and makes the window visible.
@@ -35,11 +33,7 @@ The detail view is also responsible for ensuring that there are never multiple p
 PopoverContentViewController
 A view controller that is the contents of the popovers in this sample. In this example, the view controller only contains a label with text.
 
-================================================================================
-CHANGES FROM PREVIOUS VERSIONS:
-
-Version 1.0
-- First version.
+Copyright
+---------
 
-================================================================================
-Copyright (C) 2010 Apple Inc. All rights reserved.
+Copyright (C) 2010 Apple Inc. All rights reserved.
diff --git a/PrintSample/README.md b/PrintSample/README.md
@@ -5,6 +5,7 @@ A simple example of using the UIKit Printing API in a MonoTouch application.
 
 Requires
 --------
+
 iOS 4.2 and up.
 
 Authors

diff --git a/QuartzSample/README.md b/QuartzSample/README.md
@@ -5,6 +5,7 @@ A sample of using the Core Graphics capabilities in a MonoTouch application.
 
 Preview
 -------
+
 ![iPhone running Quartz sample one](http://farm7.static.flickr.com/6132/5999556473_a801e2c50f.jpg)
 ![iPhone running Quartz sample two](http://farm7.static.flickr.com/6138/6000105490_2a67a8aa09.jpg)
 ![iPhone running Quartz sample three](http://farm7.static.flickr.com/6025/5999556761_72206a31f1.jpg)

diff --git a/ReachabilitySample/README.md b/ReachabilitySample/README.md
@@ -11,6 +11,7 @@ practices nor is it a great use of the APIs in the first place.
 
 Preview
 -------
+
 ![iPhone running Reachability sample](http://farm7.static.flickr.com/6127/6002809074_b117d7582e.jpg)
 
 Authors

diff --git a/StreamingAudio/README.md b/StreamingAudio/README.md
@@ -15,6 +15,7 @@ There are two samples:
 
 Preview
 -------
+
 ![iPhone running Streaming Audio sample](http://farm7.static.flickr.com/6144/6002389235_5c1d164cc1.jpg)
 
 Authors

diff --git a/SysSound/README.md b/SysSound/README.md
@@ -1,4 +1,4 @@
 System Sound
 ============
 
-TODO
+This sample demonstrates playing sound via AudioToolkit.
diff --git a/Touches_Classic/README.md b/Touches_Classic/README.md
@@ -3,7 +3,6 @@ Touches
 
 An example how to handle touches to move multiple objects.
 Touches_Classic demonstrates how to use the UIResponder events
-Touches_GestureRecognizers demostrate how to do it with UIGestureRecognizers.
 
 Loosely based on Apple's Touches example:
 http://developer.apple.com/library/ios/#samplecode/Touches

diff --git a/Touches_GestureRecognizers/README.md b/Touches_GestureRecognizers/README.md
@@ -2,7 +2,6 @@ Gesture Recognizers
 ===================
 
 An example how to handle touches to move multiple objects.
-Touches_Classic demonstrates how to use the UIResponder events
 Touches_GestureRecognizers demostrate how to do it with UIGestureRecognizers.
 
 Loosely based on Apple's Touches example:

diff --git a/WorldCities/README.md b/WorldCities/README.md
@@ -1,16 +1,16 @@
 World Cities
 ============
 
-Requires
---------
-iOS 5.0 and up.
-
-Description
------------
 A simple example of using the Map Kit API in a MonoTouch application.
 Based on Apple's sample:
 https://developer.apple.com/library/ios/#samplecode/WorldCities/Introduction/Intro.html#//apple_ref/doc/uid/DTS40009466
 
+Requires
+--------
+
+iOS 5.0 and up.
+
 Authors
 -------
+
 Mike Krüger 
diff --git a/ZoomingPdfViewer/README.md b/ZoomingPdfViewer/README.md
@@ -1,3 +1,6 @@
+Zooming PDF Viewer
+==================
+
 This is a port of Apple's ZoomingPDFViewer (original written in ObjectiveC) available from:
 http://developer.apple.com/library/ios/#samplecode/ZoomingPDFViewer/Introduction/Intro.html#//apple_ref/doc/uid/DTS40010281
 
@@ -6,4 +9,4 @@ http://en.wikipedia.org/wiki/Tamarin
 Text is available under the Creative Commons Attribution-ShareAlike License [1]; additional terms may apply. See Terms of use [2] for details.
 
 [1] http://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License
-[2] http://wikimediafoundation.org/wiki/Terms_of_use
+[2] http://wikimediafoundation.org/wiki/Terms_of_use
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,6 @@ Based on Apple's avTouch example: @@
     http://developer.apple.com/library/ios/#samplecode/avTouch/Introduction/Intro.html
     Authors
-    =======
+    -------
     Miguel de Icaza