Skip to content
This repository was archived by the owner on Apr 29, 2024. It is now read-only.

Commit 35ebed7

Browse files
committed
readme updates tvOS
1 parent cb5b208 commit 35ebed7

File tree

17 files changed

+107
-163
lines changed

17 files changed

+107
-163
lines changed

UICatalog/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,27 @@ products:
99
urlFragment: uicatalog
1010
---
1111
# UICatalog: Creating and Customizing UIKit Controls
12-
12+
1313
This sample is a catalog exhibiting many views and controls in the `UIKit` framework along with their various functionalities. Refer to this sample if you are looking for specific controls or views that are provided by the system.
14-
14+
1515
Note that this sample also shows you how to make your non-standard views (images or custom views) accessible. Using the iOS Accessibility API enhances the user experience of VoiceOver users.
16-
16+
1717
You will also notice this sample shows how to localize string content by using the `NSLocalizedString` macro. Each language has a "Localizeable.strings" file and this macro refers to this file when loading the strings from the default bundle.
18-
18+
19+
![UICatalog: Creating and Customizing UIKit Controls application screenshot](Screenshots/ActivityIndicators.png "UICatalog: Creating and Customizing UIKit Controls application screenshot")
20+
1921
## Using the Sample
20-
22+
2123
This sample can be run on a device or on the simulator.
22-
24+
2325
While looking over the source code of UICatalog you will find that many elements keep the same order of the view controller classes listed in the project. For example, `AAPLActionSheetViewController` is the first view controller in the UICatalog project folder, but it is also the first view controller that's shown in the master view controller's table view.
24-
26+
2527
UICatalog uses a master/detail application architecture, which can be seen in the storyboard files. The master view controller defines the list of views that are used for demonstration in this application. Each detail view controller corresponds to a given system-provided control (and is named accordingly). For example, `AAPLAlertViewController` shows how to use `UIAlertView` and its associated functionality. The only two exceptions to this rule are `UISearchBar` and `UIToolbar`; each of these controls have multiple view controllers to explain how the control works and can be customized. This is done to make sure that each view controller only has one `UIToolbar` or `UISearchBar` in a view controller at one point in time. Each view controller is responsible for configuring a set of of specific controls that have been set in Interface Builder.
26-
28+
2729
## UIKit Controls
28-
30+
2931
UICatalog demonstrates how to configure and customize the following controls:
30-
32+
3133
* UIActionSheet
3234
* UIActivityIndicatorView
3335
* UIAlertView
@@ -47,16 +49,10 @@ UICatalog demonstrates how to configure and customize the following controls:
4749
* UISearchBar
4850
* UIToolbar
4951

50-
## Build Requirements
52+
## Build Requirements
5153

5254
Xamarin.iOS 11.0+ and Xcode 9.0+.
5355

5456
## License
5557

5658
Xamarin port changes are released under the MIT license.
57-
58-
![UICatalog: Creating and Customizing UIKit Controls application screenshot](Screenshots/ActivityIndicators.png "UICatalog: Creating and Customizing UIKit Controls application screenshot")
59-
60-
## Author
61-
62-
Ported to Xamarin.iOS by Rustam Zaitov/Mykyta Bondarenko.

UIImageEffects/README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,7 @@ urlFragment: uiimageeffects
1212

1313
This is a port of Apple's UIImageEffect sample
1414

15-
From Apple:
15+
## Main classes
1616

17-
UIImageEffects shows how to create and apply blur and tint effects to an image using the vImage, Quartz, and UIKit frameworks.
18-
19-
The vImage framework is suited for high-performance image processing. Using vImage, our app gets all the benefits of vector processing without the need for you to write vectorized code.
20-
21-
##Main classes:
22-
23-
###ViewController.cs:
24-
25-
Calls the various filters on each tap.
26-
27-
###UIImageEffect.cs:
28-
29-
Contains various extension methods that allow the user to blur images and tint those images. The convenience methods show how to use the API.
17+
- ViewController.cs – Calls the various filters on each tap.
18+
- UIImageEffect.cs – Contains various extension methods that allow the user to blur images and tint those images. The convenience methods show how to use the API.

ViewTransitions/README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Xamarin.iOS - View Transitions
3-
description: An example on how to use Core Animation transitions. Requires This sample requires the new MonoDevelop 2.8 support for XCode 4 integration. Preview...
3+
description: An example on how to use Core Animation transitions
44
page_type: sample
55
languages:
66
- csharp
@@ -12,17 +12,9 @@ urlFragment: viewtransitions
1212

1313
An example on how to use Core Animation transitions.
1414

15-
## Requires
16-
17-
This sample requires the new MonoDevelop 2.8 support for XCode 4 integration.
15+
![View Transitions application screenshot](Screenshots/ViewTransitions1.png "View Transitions application screenshot")
1816

1917
## Preview
2018

2119
Loosely based on Apple's ViewTransitions example:
2220
http://developer.apple.com/library/ios/#samplecode/ViewTransitions
23-
24-
![View Transitions application screenshot](Screenshots/ViewTransitions1.png "View Transitions application screenshot")
25-
26-
## Authors
27-
28-
Mike Krüger

tvos/Hello-tvOS/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
11
---
22
name: Xamarin.iOS - Hello, tvOS
3-
description: This sample implements a simple Hello World app in Xamarin.tvOS and presents the basics of working with tvOS. Build Requirements Please see our...
3+
description: "Implements a simple Hello World app in Xamarin.tvOS and presents the basics of working with tvOS (get started)"
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
12+
- getstarted
913
urlFragment: tvos-hello-tvos
1014
---
1115
# Hello, tvOS
1216

1317
This sample implements a simple "Hello World" app in Xamarin.tvOS and presents the basics of working with tvOS.
1418

19+
![Hello, tvOS application screenshot](Screenshots/01.png "Hello, tvOS application screenshot")
20+
1521
## Build Requirements
1622

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
23+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1824

1925
## Runtime Requirements
2026

@@ -25,11 +31,3 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2531
* [tvOS](https://developer.apple.com/tvos/)
2632
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
2733
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![Hello, tvOS application screenshot](Screenshots/01.png "Hello, tvOS application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-

tvos/UICatalog/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,18 @@ languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-uicatalog
1013
---
1114

1215
# tvOS UICatalog
1316

1417
Demonstrates how to use many views and controls in the UIKit framework on tvOS. Refer to this sample if you are looking for specific controls or views that are provided by the system.
1518

19+
![tvOS UICatalog application screenshot](Screenshots/0.png "tvOS UICatalog application screenshot")
20+
1621
## Build Requirements
1722

1823
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/get-started/installation/) documentation to install the necessary requirements to run this sample.
@@ -28,9 +33,3 @@ Simulator or device with tvOS 9.0 or later
2833
## Copyright
2934

3035
Xamarin port changes are released under the MIT license
31-
32-
![tvOS UICatalog application screenshot](Screenshots/0.png "tvOS UICatalog application screenshot")
33-
34-
## Author
35-
36-
Ported to Xamarin.TVOS by Oleg Demchenko

tvos/tvAlerts/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
name: Xamarin.iOS - tvAlerts
3-
description: This sample shows how to work with alerts in a Xamarin.tvOS app. Build Requirements Please see our Installing tvOS Support documentation to install...
3+
description: This sample shows how to work with alerts in a Xamarin.tvOS app (tvOS)
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-tvalerts
1013
---
1114
# tvAlerts
1215

13-
This sample shows how to work with alerts in a Xamarin.tvOS app.
16+
This sample shows how to work with alerts in a Xamarin.tvOS app.
17+
18+
![tvAlerts application screenshot](Screenshots/01.png "tvAlerts application screenshot")
1419

1520
## Build Requirements
1621

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
22+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1823

1924
## Runtime Requirements
2025

@@ -25,11 +30,3 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2530
* [tvOS](https://developer.apple.com/tvos/)
2631
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
2732
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![tvAlerts application screenshot](Screenshots/01.png "tvAlerts application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-

tvos/tvButtons/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
name: Xamarin.iOS - tvButtons
3-
description: This sample shows how to work with buttons is a Xamarin.tvOS app. Build Requirements Please see our Installing tvOS Support documentation to...
3+
description: This sample shows how to work with buttons is a Xamarin.tvOS app (tvOS)
44
page_type: sample
55
languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-tvbuttons
1013
---
1114
# tvButtons
1215

1316
This sample shows how to work with buttons is a Xamarin.tvOS app.
1417

18+
![tvButtons application screenshot](Screenshots/01.png "tvButtons application screenshot")
19+
1520
## Build Requirements
1621

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
22+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1823

1924
## Runtime Requirements
2025

@@ -25,11 +30,3 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2530
* [tvOS](https://developer.apple.com/tvos/)
2631
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
2732
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![tvButtons application screenshot](Screenshots/01.png "tvButtons application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-

tvos/tvCollection/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-tvcollection
1013
---
1114
# tvCollection
1215

1316
This sample shows how to work with Collection View Controllers in a Xamarin.tvOS app.
1417

18+
![tvCollection application screenshot](Screenshots/01.png "tvCollection application screenshot")
19+
1520
## Build Requirements
1621

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
22+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1823

1924
## Runtime Requirements
2025

@@ -25,11 +30,3 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2530
* [tvOS](https://developer.apple.com/tvos/)
2631
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
2732
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![tvCollection application screenshot](Screenshots/01.png "tvCollection application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-

tvos/tvFocus/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-tvfocus
1013
---
1114
# tvFocus
1215

1316
This sample shows how to work with Focus Guides is a Xamarin.tvOS app. Focus Guides provide a mechanism that allows otherwise inaccessible User Interface elements to be navigated to by creating a virtual bridge between them.
1417

18+
![tvFocus application screenshot](Screenshots/01.png "tvFocus application screenshot")
19+
1520
## Build Requirements
1621

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
22+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1823

1924
## Runtime Requirements
2025

@@ -24,12 +29,4 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2429

2530
* [tvOS](https://developer.apple.com/tvos/)
2631
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
27-
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![tvFocus application screenshot](Screenshots/01.png "tvFocus application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-
32+
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)

tvos/tvNavBars/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ languages:
66
- csharp
77
products:
88
- xamarin
9+
extensions:
10+
tags:
11+
- tvos
912
urlFragment: tvos-tvnavbars
1013
---
1114
# tvNavBars
1215

1316
This sample shows how to work with Navigation Bars in a Xamarin.tvOS app.
1417

18+
![tvNavBars application screenshot](Screenshots/01.png "tvNavBars application screenshot")
19+
1520
## Build Requirements
1621

17-
Please see our [Installing tvOS Support](/guides/ios/tvos/getting-started/installation/) documentation to install the necessary requirements to run this sample.
22+
Please see our [Installing tvOS Support](https://docs.microsoft.com/xamarin/ios/tvos/get-started/installation) documentation to install the necessary requirements to run this sample.
1823

1924
## Runtime Requirements
2025

@@ -25,11 +30,3 @@ This sample can be launched on the tvOS Simulator and real 4th generation Apple
2530
* [tvOS](https://developer.apple.com/tvos/)
2631
* [tvOS Human Interface Guides](https://developer.apple.com/tvos/human-interface-guidelines/)
2732
* [App Programming Guide for tvOS](https://developer.apple.com/library/prerelease/tvos/documentation/General/Conceptual/AppleTV_PG/)
28-
29-
![tvNavBars application screenshot](Screenshots/01.png "tvNavBars application screenshot")
30-
31-
## Author
32-
33-
Kevin Mullins for Xamarin, Inc.
34-
35-

0 commit comments

Comments
 (0)