Skip to content

Latest commit

 

History

History
97 lines (58 loc) · 7.35 KB

readme.md

File metadata and controls

97 lines (58 loc) · 7.35 KB

Gitter Discord Build Status Backers on Open Collective Sponsors on Open Collective License
NuGet downloads MyGet Size

Avalonia

📖 About AvaloniaUI

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 via .NET Framework and .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.

Note: The UI theme you see in the picture above is still work-in-progress and will be available in the upcoming Avalonia 0.10.0 release. However, you can connect to our nightly build feed and install latest pre-release versions of Avalonia NuGet packages, if you are willing to help out with the development and testing. See Using nightly build feed for more info.

To see the status of some of our features, please see our Roadmap. 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 starter 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

Showcase

Examples of UIs built with Avalonia image

image

image

image

JetBrains Rider

If you need to develop Avalonia app with JetBrains Rider you can use latest Rider preview builds.

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 https://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.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Licence

Avalonia is licenced under the MIT licence.

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]

.NET Foundation

This project is supported by the .NET Foundation.