Skip to content

Commit

Permalink
Update README (#20536)
Browse files Browse the repository at this point in the history
Update README in preparation for May 1
  • Loading branch information
rachelkang authored May 1, 2024
1 parent 836577b commit de51101
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
<img src="banner.png" alt="Xamarin.iOS + Xamarin.Mac logo" height="145" >

# Xamarin.iOS & Xamarin.Mac #
# .NET for iOS, Mac Catalyst, macOS, tvOS #

## Welcome!

This module is the main repository for both **Xamarin.iOS** and **Xamarin.Mac**.
This module is the main repository for:
- **.NET for iOS**
- **.NET for Mac Catalyst**
- **.NET for macOS**
- **.NET for tvOS**

These SDKs allow us to create native iOS, Mac Catalyst, macOS and tvOS applications using the same UI controls we would in Objective-C and Xcode, except with the flexibility and elegance of a modern language (C#), the power of the .NET Base Class Library (BCL), and first-class IDEs and editors&mdash;Visual Studio and Visual Studio Code&mdash;at our fingertips.

These SDKs allow us to create native iOS, tvOS, watchOS and macOS applications using the same UI controls we would in Objective-C and Xcode, except with the flexibility and elegance of a modern language (C#), the power of the .NET Base Class Library (BCL), and two first-class IDEs&mdash;Visual Studio for Mac and Visual Studio&mdash;at our fingertips.
This repository is where we do development for the .NET for iOS, Mac Catalyst, macOS, and tvOS SDKs. .NET for iOS, Mac Catalyst, macOS, and tvOS are part of [.NET MAUI][maui-intro], and may also be used independently for native iOS and macOS development with .NET.

This repository is where we do development for the Xamarin.iOS and Xamarin.Mac SDKs. There are a few ways that you can contribute, for example:
There are a few ways that you can contribute, for example:

- [Submit bugs and feature requests](https://github.com/xamarin/xamarin-macios/wiki/Submitting-Bugs-&-Suggestions)
- [Review source code changes](https://github.com/xamarin/xamarin-macios/pulls)
- [Submit pull requests](https://github.com/xamarin/xamarin-macios/wiki/How-to-Contribute#pull-requests) to resolve issues and fix bugs

[maui-intro]: https://learn.microsoft.com/en-us/dotnet/maui/what-is-maui

## Support

.NET for iOS, Mac Catalyst, macOS, and tvOS are part of .NET MAUI, since it was introduced in May 2022 as part of .NET 6, and is currently supported as described on the [.NET MAUI Support Policy][maui-support-policy].

Support for Xamarin.iOS and Xamarin.Mac ended on **May 1, 2024** as per the [Xamarin Support Policy][xamarin-support-policy]:

> Xamarin support ended on May 1, 2024 for all Xamarin SDKs including Xamarin.Forms. Android API 34 and Xcode 15 SDKs (iOS and iPadOS 17, macOS 14) are the final versions Xamarin targets from existing Xamarin SDKs (i.e. no new APIs are planned).
[maui-support-policy]: https://dotnet.microsoft.com/en-us/platform/support/policy/maui
[xamarin-support-policy]: https://dotnet.microsoft.com/en-us/platform/support/policy/xamarin

## Contributing

If you are interested in fixing issues and contributing directly to the code base, please see the document [How to Contribute](https://github.com/xamarin/xamarin-macios/wiki/How-to-Contribute), which covers the following:
Expand Down

0 comments on commit de51101

Please sign in to comment.