From 971ca6bc332525edb5a1b61c4c045dc41e6fabe5 Mon Sep 17 00:00:00 2001 From: Ikarago Date: Mon, 24 Jun 2019 21:34:53 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 4ab8064..b611cac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # FLUI Framework FLUI Framework (short for Fluent UI Framework) is an effort to bring standardisation to Microsofts Fluent Design by providing easy-to-use styles and controls to developers so they won’t have to reinvent the wheel for styling their apps. +This library is meant to fill the gaps of the [WinUI library](https://github.com/Microsoft/microsoft-ui-xaml) by providing styles and margins for classic controls and standard TextBlocks. It also adds styles for icons to be used in tandem with their respective style whereas MDL2 was lacking such a thing. + +## Current styles +![Fonts and Controls FLUI Framework vs MDL2](https://raw.githubusercontent.com/Team-FLUI/FluiFramework/master/.github/Assets/Readme/FontsControls-2019-6-24.png) ## How to use Add the following [NuGet package](https://www.nuget.org/packages/FluiFramework.UWP) to your project and reference it in your App.xaml. flui is a reference in your XAML to FluiFramework.UWP.Core. @@ -13,6 +17,9 @@ Add the following [NuGet package](https://www.nuget.org/packages/FluiFramework.U +After you've done this you can use the styles laid out in the Wiki on the controls specified there. For instance, you can give a title TextBlock a Fluent title by applying the *FluentTitleTextStyle* style. For example: + +`` ## Supported Windows versions **Minimal supported Windows 10 version:** 15063 (Version 1703, Creators Update) From 2b8267df28bc9585a3337dbd3376b96d8fe3474c Mon Sep 17 00:00:00 2001 From: Ikarago Date: Mon, 24 Jun 2019 21:43:23 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b611cac..1a61b49 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,8 @@ After you've done this you can use the styles laid out in the Wiki on the contro ## Notes FLUI Framework will automatically check which resources can be applied on the running Windows version. If the running OS version doesn't support a feature (like the CornerRadius on pre-1809 devices) it'll use a compatible version of the stylesheet that doesn't incorporate it and thus won't use rounded corners. +Please note that this library still is in full development. Styles (aside from the TextBlock-styles) can be updates with a (slightly) different look over time to align it more with the Fluent Design specifications from Microsoft or due to compatibility reasons. + ## Support us **Like this project?** Support it by using it in your UWP projects and to share about it with #FLUI and #FluiFramework on Twitter! From 9744edb1c511ef4d0bf589e8dc15c2fa7cc5a7c9 Mon Sep 17 00:00:00 2001 From: Ikarago Date: Fri, 28 Jun 2019 11:29:12 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1a61b49..bfb852c 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ FLUI Framework will automatically check which resources can be applied on the ru Please note that this library still is in full development. Styles (aside from the TextBlock-styles) can be updates with a (slightly) different look over time to align it more with the Fluent Design specifications from Microsoft or due to compatibility reasons. +This projects is not affiliated with Microsoft, but they are free to reach out and/or use the code within the project for addition to their own repositories. :) ## Support us **Like this project?** Support it by using it in your UWP projects and to share about it with #FLUI and #FluiFramework on Twitter!