diff --git a/docs/add-dialogs.png b/docs/add-dialogs.png new file mode 100644 index 0000000000..c89d025e01 Binary files /dev/null and b/docs/add-dialogs.png differ diff --git a/docs/add-packages.png b/docs/add-packages.png new file mode 100644 index 0000000000..4f7e57ad68 Binary files /dev/null and b/docs/add-packages.png differ diff --git a/docs/gettingstarted.md b/docs/gettingstarted.md new file mode 100644 index 0000000000..21f85a7088 --- /dev/null +++ b/docs/gettingstarted.md @@ -0,0 +1,15 @@ +# Getting Started + +## Windows + +![](add-dialogs.png) + +The easiest way to try out Perspex is to install the Visual Studio Extension. + +This will add a Perspex project template and a Window template to the standard Visual Studo “Add” dialog (yes, icons still to come :) ): + +## OSX / Linux + +It is a little more manual on non-Windows platforms, but using Xamarin Studio you can install the Perspex NuGet package. + +![](add-packages.png) diff --git a/docs/perspex-video.png b/docs/perspex-video.png new file mode 100644 index 0000000000..2af3fd4c91 Binary files /dev/null and b/docs/perspex-video.png differ diff --git a/docs/screen.png b/docs/screen.png index 45914f87fc..a321a8d6e3 100644 Binary files a/docs/screen.png and b/docs/screen.png differ diff --git a/readme.md b/readme.md index 03f69f235e..93cd355c60 100644 --- a/readme.md +++ b/readme.md @@ -7,6 +7,16 @@ A multi-platform .NET UI framework. ![](docs/screen.png) +![](docs/perspex-video.png)] + +## NuGet + +Perspex is delivered as a NuGet package. +You can find the packages here: ([stable(ish)](https://www.nuget.org/packages/Perspex/), [nightly](https://www.myget.org/F/perspex-nightly/api/v2/Packages)) + +You can install the package like this: +`Install-Package Perspex -Pre` + ## Background Perspex is a multi-platform windowing toolkit - somewhat like WPF - that is intended to be multi- @@ -26,8 +36,8 @@ framework. ## Documentation -As mentioned above, Perspex is still in alpha and as such there's not much documentation yet. You can -take a look at the [alpha release announcement](http://grokys.github.io/perspex/perspex-alpha/) for an +As mentioned above, Perspex is still in alpha and as such there's not much documentation yet. You can +take a look at the [getting started page](docs/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/grokys/Perspex).