From ecc79607d7e45b205747cc1dcdde1be3b0f2ac59 Mon Sep 17 00:00:00 2001 From: Artjom Date: Thu, 5 Oct 2017 21:29:35 +0300 Subject: [PATCH] Update readme.md The first time I've seen Avalonia's readme, I was a bit confused about how to quickly get started with the framework. So this readme update includes a new paragraph named "Getting Started" where I've tried to point out how to create a simple "Hello world" application! --- readme.md | 57 ++++++++++++++++++------------------------------------- 1 file changed, 18 insertions(+), 39 deletions(-) diff --git a/readme.md b/readme.md index 3f4840fce2..3fce3719db 100644 --- a/readme.md +++ b/readme.md @@ -1,70 +1,49 @@ # Avalonia - | Gitter Chat | Windows Build Status | Linux/Mac Build Status | |---|---|---| | [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/AvaloniaUI/Avalonia?utm_campaign=pr-badge&utm_content=badge&utm_medium=badge&utm_source=badge) | [![Build status](https://ci.appveyor.com/api/projects/status/hubk3k0w9idyibfg/branch/master?svg=true)](https://ci.appveyor.com/project/AvaloniaUI/Avalonia/branch/master) | [![Build Status](https://travis-ci.org/AvaloniaUI/Avalonia.svg?branch=master)](https://travis-ci.org/AvaloniaUI/Avalonia) | -A multi-platform .NET UI framework. It can run on Windows, Linux, Mac OS X, iOS and Android. +A multi-platform .NET UI framework. It runs on Windows, Linux, Mac OS X, iOS and Android. -[![](docs/images/screen.png)](https://youtu.be/wHcB3sGLVYg) +| Control catalog | Desktop platforms | Mobile platforms | +|---|---|---| +| | | | -Desktop platforms: +## About -![](docs/images/avalonia-video.png) +Avalonia is a multi-platform windowing toolkit - somewhat like WPF - that is intended to be multi-platform. It supports XAML, lookless controls and a flexible styling system, and runs on Windows using Direct2D and other operating systems using Skia and OS-specific windowing backend (GTK, Cocoa, etc). -Mobile platforms: +Avalonia is now in alpha. What does "alpha" mean? Well, it means that it's now at a stage where you can have a play and hopefully create simple applications. There's still a lot missing, and you *will* find bugs, and the API *will* change, but this represents the first time where we've made it somewhat easy to have a play and experiment with the framework. -![](https://i.ytimg.com/vi/NJ9-hnmUbBM/hqdefault.jpg) +## Getting Started -## NuGet +Avalonia [Visual Studio Extension](https://marketplace.visualstudio.com/items?itemName=AvaloniaTeam.AvaloniaforVisualStudio) contains project and control templates that will help you get started. After installing it, open "New Project" dialog in Visual Studio, choose "Avalonia" in "Visual C#" section and press OK (screenshot). Now you can write code and markup that will work on multiple platforms! -Avalonia is delivered as a NuGet package. -You can find the packages here: ([stable(ish)](https://www.nuget.org/packages/Avalonia/), [nightly](https://github.com/AvaloniaUI/Avalonia/wiki/Using-nightly-build-feed)) +Avalonia is also delivered as a NuGet package. You can find the packages here: ([stable(ish)](https://www.nuget.org/packages/Avalonia/), [nightly](https://github.com/AvaloniaUI/Avalonia/wiki/Using-nightly-build-feed)) -You can install the package like this: -`Install-Package Avalonia -Pre` +Use this command in Package Manager console to install the package: +``` +Install-Package Avalonia -Pre +``` ## Bleeding Edge Builds Try out the latest build of Avalonia available for download here: https://ci.appveyor.com/project/AvaloniaUI/Avalonia/branch/master/artifacts -Try out the ControlCatalog to give it a quick demo. - -## Background - -Avalonia is a multi-platform windowing toolkit - somewhat like WPF - that is intended to be multi- -platform. It supports XAML, lookless controls and a flexible styling system, and runs on Windows -using Direct2D and other operating systems using Skia and OS-specific windowing backend (GTK, Cocoa, etc). - -## Current Status - -Avalonia is now in alpha. What does "alpha" mean? Well, it means that it's now at a stage where you -can have a play and hopefully create simple applications. There's now a [Visual -Studio Extension](https://marketplace.visualstudio.com/items?itemName=AvaloniaTeam.AvaloniaforVisualStudio) -containing project and item templates that will help you get started, and -there's an initial complement of controls. There's still a lot missing, and you -*will* find bugs, and the API *will* change, but this represents the first time -where we've made it somewhat easy to have a play and experiment with the -framework. - ## Documentation -As mentioned above, Avalonia is still in alpha and as such there's not much documentation yet. You can -take a look at the [getting started page](docs/tutorial/gettingstarted.md) for an -overview of how to get started but probably the best thing to do for now is to already know a little bit -about WPF/Silverlight/UWP/XAML and ask questions in our [Gitter room](https://gitter.im/AvaloniaUI/Avalonia). +As mentioned above, Avalonia is still in alpha and as such there's not much documentation yet. You can take a look at the [getting started page](docs/tutorial/gettingstarted.md) for an overview of how to get started but probably the best thing to do for now is to already know a little bit about WPF/Silverlight/UWP/XAML and ask questions in our [Gitter room](https://gitter.im/AvaloniaUI/Avalonia). -There's also a high-level [architecture document](docs/spec/architecture.md) that is currently a little bit -out of date, and I've also started writing blog posts on Avalonia at http://grokys.github.io/. +There's also a high-level [architecture document](docs/spec/architecture.md) that is currently a little bit out of date, and I've also started writing blog posts on Avalonia at http://grokys.github.io/. Contributions are always welcome! ## Building and Using -See the [build instructions here](docs/guidelines/build.md) +See the [build instructions here](docs/guidelines/build.md). -## Contributing ## +## Contributing Please read the [contribution guidelines](docs/guidelines/contributing.md) before submitting a pull request.