improving the readme experience

xamarin · Jul 23, 2019 · 3c0a72a · 3c0a72a
1 parent f899362
commit 3c0a72a
Show file tree

Hide file tree

Showing 28 changed files with 282 additions and 124 deletions.
diff --git a/AnimatedClock/README.md b/AnimatedClock/README.md
@@ -15,6 +15,13 @@ This is based on the GlossyClock sample.
 
 ![AnimatedClock application screenshot](Screenshots/0.png "AnimatedClock application screenshot")
 
-## Author
+## Prerequisites
 
-Ported to Xamarin.Mac by Rolf Bjarne Kvinge.
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/AnimatingViews/README.md b/AnimatingViews/README.md
@@ -11,3 +11,16 @@ urlFragment: animatingviews
 # AnimatingViews
 
 The Animating View sample shows how to use `CoreAnimation` to animate views. The code that does the animation lives in the `AnimatingViewsWindowController.cs` file and shows how to animate either using the simple API (just assigning a value to the Frame property) or manually controlling the animation's properties.
+
+![AnimatingViews application screenshot](Screenshots/0.png "AnimatingViews application screenshot")
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/ButtonMadness/Readme.md b/ButtonMadness/Readme.md
@@ -1,5 +1,5 @@
 ---
-name: Xamarin.Mac - ButtonMaddness
+name: Xamarin.Mac - ButtonMadness
 description: This is a button sample for mac.
 page_type: sample
 languages:
@@ -11,3 +11,16 @@ urlFragment: buttonmadness
 # ButtonMaddness
 
 This is a button sample for mac.
+
+![ButtonMadness application screenshot](Screenshots/0.png "ButtonMadness application screenshot")
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/CAQuartzComposition/README.md b/CAQuartzComposition/README.md
@@ -12,19 +12,19 @@ urlFragment: caquartzcomposition
 
 Shows the use of the `CoreAnimation` and `QuartzComposition` `QCCompositionLayer`.  
 For a full description of the program and the original article point your browser here:  
-[Core Animation Tutorial]
+[Core Animation Tutorial](http://www.cimgf.com/2008/09/24/core-animation-tutorial-core-animation-and-quartz-composer-qccompositionlayer/#more-289)
 
-## Instructions
+![CAQuartzComposition application screenshot](Screenshots/0.png "CAQuartzComposition application screenshot")
 
-There are two menu options you can access from the View menu item.
+## Prerequisites
 
-* Switch View - which will switch between the to Quartz Compositions.
-* Use Filters - which toggles the use of filters being applied to the layer or not.
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
 
-![CAQuartzComposition application screenshot](Screenshots/0.png "CAQuartzComposition application screenshot")
+## Running the sample
 
-## Author
-
-Ported to Xamarin.Mac by Kenneth J. Pouncey.
+There are two menu options you can access from the View menu item.
 
-[Core Animation Tutorial]:http://www.cimgf.com/2008/09/24/core-animation-tutorial-core-animation-and-quartz-composer-qccompositionlayer/#more-289
+* Switch View - which will switch between the to Quartz Compositions.
+* Use Filters - which toggles the use of filters being applied to the layer or not.
diff --git a/CFNetwork/Readme.md b/CFNetwork/Readme.md
@@ -10,4 +10,15 @@ urlFragment: cfnetwork
 ---
 # CFNetwork
 
-CFNetwork Xamarin.Mac sample.
+CFNetwork example for Xamarin.Mac.
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/CircleView/Readme.md b/CircleView/Readme.md
@@ -12,14 +12,23 @@ urlFragment: circleview
 
 This is a sample ported from Swift which draws text on a custom view using `NSLayoutManager`.
 
+![Text wrapped around a circle in a Mac spp](Screenshots/0.png)
+
 ## Runtime
+
 OS X 10.10+
 
-## Copyright
+## Prerequisites
 
-Xamarin port changes are released under the MIT license
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
 
-## Author
+## Running the sample
 
-Ported to Xamarin.Mac by Chris Hamons
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
 
+## License
+
+Xamarin port changes are released under the MIT license
diff --git a/CircleView/Screenshots/0.png b/CircleView/Screenshots/0.png
diff --git a/Constraints/README.md b/Constraints/README.md
@@ -12,17 +12,23 @@ urlFragment: constraints
 
 This sample shows how to use UI constraints in Xamarin.Mac apps.
 
+![Constraints application screenshot](Screenshots/1.png "Constraints application screenshot")
 
 ## Build Requirements
 
 OS X 10.12, Xcode 8.0 or later
 
 ## Runtime
+
 OS X 10.12
 
+## Prerequisites
 
-![Constraints application screenshot](Screenshots/1.png "Constraints application screenshot")
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
 
-## Author
+## Running the sample
 
-Timothy Risi
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/CoreAnimationBook/README.md b/CoreAnimationBook/README.md
@@ -14,6 +14,13 @@ The samples in this directory are ports from the book "Pragmatic's Core Animatio
 
 ![CoreAnimationBook application screenshot](Screenshots/1.png "CoreAnimationBook application screenshot")
 
-## Author 
+## Prerequisites
 
-Ported to Xamarin.Mac by Kenneth J. Pouncey.
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/CoreTextArcMonoMac/ReadMe.md b/CoreTextArcMonoMac/ReadMe.md
@@ -13,9 +13,11 @@ urlFragment: coretextarcmonomac
 Illustrates how to use `CoreText` to draw text along an arc in a Xamarin.Mac application.
 
 The main drawing functionality demonstrated in this application is implemented in a custom `NSView` called `CoreTextArcView`.  
-All of the interresting functionality in that view is encapsulated in the  -drawRect: method in the `CoreTextArcView.cs` file.  
+All of the interesting functionality in that view is encapsulated in the  `-drawRect:` method in the **CoreTextArcView.cs** file.  
 There, `CoreText` is used to layout and draw glyphs along a curve.
 
+![CoreTextArcMonoMac application screenshot](Screenshots/0.png "CoreTextArcMonoMac application screenshot")
+
 ## NSFontPanel
 
 This sample also makes use of the `NSFontPanel` to allow user configuration of the text being displayed in the custom view.  
@@ -27,19 +29,13 @@ This functionality can be found in the file `MyDocument.cs`. Key points to make
 
 3. The methods -toggleBold: and -toggleItalic: are called in response to user clicks in the italic and bold checkboxes. In these methods, the respective font attributes are changed and then the current settings are synchronized to the font pane and to the custom view.
 
-## Instructions
+## Running the sample
 
 * Build and run this sample.  
 * When launched, the application will display a string drawn along an curve.  
 * Click in the checkboxes in wthe window to change some font settings.  
 * Choose the "Show Fonts" menu item from the "Format" menu to open the font panel so you can change additional font settings.
 
-## Copyright
+## License
 
 Xamarin port changes are released under the MIT license
-
-![CoreTextArcMonoMac application screenshot](Screenshots/0.png "CoreTextArcMonoMac application screenshot")
-
-## Author
-
-Ported to Xamarin.Mac by Kenneth J. Pouncey.
diff --git a/CoreWLANWirelessManager/README.md b/CoreWLANWirelessManager/README.md
@@ -35,6 +35,13 @@ Also there is another one push button entitled "Create IBSS". A sheet will be pr
 
 ![CoreWLANWirelessManager application screenshot](Screenshots/1.png "CoreWLANWirelessManager application screenshot")
 
-## Author
+## Prerequisites
 
-Ported to Xamarin.Mac by Oleg Demchenko.
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/CustomFont/Readme.md b/CustomFont/Readme.md
@@ -10,4 +10,17 @@ urlFragment: customfont
 ---
 # Custom Fonts
 
-This sample shows how to embed a custom font in a Xamarin.Mac application and how to use that font in a User Interface item.
+This sample shows how to embed a custom font in a Xamarin.Mac application and how to use that font in a User Interface item.
+
+![Custom font used in a Mac app](Screenshots/0.png)
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/DatePicker/README.md b/DatePicker/README.md
@@ -14,6 +14,13 @@ Shows the use of the `NSDatePicker` control with Xamarin.Mac.
 
 ![DatePicker application screenshot](Screenshots/0.png "DatePicker application screenshot")
 
-## Author
+## Prerequisites
 
-Ported to Xamarin.Mac by Kenneth Pouncey.
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/DockAppIcon/README.md b/DockAppIcon/README.md
@@ -16,15 +16,18 @@ Shows the use of the `NSDockTile`.
 * Manipulating the Application Badge.
 * Getting the users attention: Informational and Critical.
 
-## Instructions
+![DockAppIcon application screenshot](Screenshots/0.png "DockAppIcon application screenshot")
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
 
 To see the request for attention:
+
 * Use the Request Button.
 * Move away from this application by activating another application within 3 seconds.
 * The requests only work if the requesting application is not the active application.
-
-![DockAppIcon application screenshot](Screenshots/0.png "DockAppIcon application screenshot")
-
-## Author
-
-Ported to Xamarin.Mac by Kenneth J. Pouncey.
diff --git a/DocumentSample/README.md b/DocumentSample/README.md
@@ -17,3 +17,16 @@ Document-based applications are supported by the `NSDocument` family of classes
 They take care of loading, saving, creating new instances and closing of windows for you.
 
 In addition to this sample, there is a template in Xamarin Studio that will create the basics for you.
+
+![Sample document app](Screenshots/0.png)
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/DragAndDropExample/Readme.md b/DragAndDropExample/Readme.md
@@ -17,4 +17,17 @@ The drag will contain two items:
 * `NSString` - A `NSString` value containing the value _"Hello World"_.
 * `NSImage` - A `NSImage` containing a House icon.
 
-When the drop happens on the **Green View**, the drop counter will be incremented and the contents of the drag package will be read and displayed in the console.
+When the drop happens on the **Green View**, the drop counter will be incremented and the contents of the drag package will be read and displayed in the console.
+
+![Sample drag and drop sample](Screenshots/0.png)
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/DrawerMadness/Readme.md b/DrawerMadness/Readme.md
@@ -11,3 +11,16 @@ urlFragment: drawermadness
 # DrawerMadness
 
 DrawerMadness Xamarin.Mac sample.
+
+![Sample app with drawers off every edge](Screenshots/0.png)
+
+## Prerequisites
+
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
+
+## Running the sample
+
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
diff --git a/ExtensionSamples/README.md b/ExtensionSamples/README.md
@@ -10,27 +10,37 @@ urlFragment: extensionsamples
 ---
 # ExtensionSamples
 
-This sample demonstrates how to use app extensions in Xamarin.Mac. To register an extension on your machine you'll need run the host application, **ExtensionSamples** one time and then enable each plugin from the **System Preference** Extension panel. 
+This sample demonstrates how to use app extensions in Xamarin.Mac. To register an extension on your machine you'll need run the host application, **ExtensionSamples** one time and then enable each plugin from the **System Preference** Extension panel.
 
 Open "Console" application to view the system log to view NSLog / Errors / Crashes of extension. Cleaning this project will unregister this plugin from the system.
 
 Sample extensions:
+
 * Share extension
 * Finder extension
 * Today extension
 
+![ExtensionSamples application screenshot](Screenshots/0.png "ExtensionSamples application screenshot")
+
 ## Build Requirements
+
 OS X 10.11, Xcode 7.0 or later
 
-## Runtime
-OS X 10.11
+## Prerequisites
 
-## Copyright
+* Mac computer with the latest version of macOS.
+* [Visual Studio for Mac](https://visualstudio.microsoft.com/vs/mac/).
+* Latest version of [Xcode](https://developer.apple.com/xcode/) from Apple.
 
-Xamarin samples released under the MIT license
+## Running the sample
 
-![ExtensionSamples application screenshot](Screenshots/0.png "ExtensionSamples application screenshot")
+1. Open the solution file (**.sln**) in Visual Studio for Mac.
+1. Use the **Run** button or menu to start the app.
+
+## Runtime
 
-## Author
+OS X 10.11
+
+## License
 
-Chris Hamons
+Xamarin samples released under the MIT license