Avalonia/readme.md

5.8 KiB

Avalonia

Gitter Chat Build Status (Win, Linux, OSX) Open Collective NuGet MyGet
Gitter Build Status Backers on Open Collective Sponsors on Open Collective NuGet MyGet

About

Avalonia is a cross-platform XAML-based UI framework providing a flexible styling system and supporting a wide range of Operating Systems such as Windows (.NET Framework, .NET Core), Linux (via Xorg), macOS.

Avalonia is ready for General-Purpose Desktop App Development. However, there may be some bugs and breaking changes as we continue along into this project's development.

To see the status of some of our features, please see our Roadmap here.

You can also see what breaking changes we have planned and what our past breaking changes have been.

Awesome Avalonia is community-curated list of awesome Avalonia UI tools, libraries, projects and resources. Go and see what people are building with Avalonia!

Getting Started

The Avalonia Visual Studio Extension contains project and control templates that will help you get started, or you can use the .NET Core CLI. For a starer guide see our documentation.

Avalonia is delivered via NuGet package manager. You can find the packages here: https://www.nuget.org/packages/Avalonia/

Use these commands in the Package Manager console to install Avalonia manually:

Install-Package Avalonia
Install-Package Avalonia.Desktop

JetBrains Rider

If you need to develop Avalonia app with JetBrains Rider, go and vote on this issue in their tracker. JetBrains won't do things without their users telling them that they want the feature, so only YOU can make it happen.

Bleeding Edge Builds

We also have a nightly build which tracks the current state of master. Although these packages are less stable than the release on NuGet.org, you'll get all the latest features and bugfixes right away and many of our users actually prefer this feed!

Documentation

Documentation can be found on our website at http://avaloniaui.net/docs/. We also have a tutorial over there for newcomers.

Building and Using

See the build instructions here.

Contributing

Please read the contribution guidelines before submitting a pull request.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]