update readmes

Add ConsoloniaApplication<MainWindow>
Cleaned up turbovision stuff

Directory.Build.props

@@ -5,7 +5,7 @@
         <Nullable>disable</Nullable>
     </PropertyGroup>
     <PropertyGroup>
-        <VersionPrefix>11.0.9</VersionPrefix>
+        <VersionPrefix>11.2.1</VersionPrefix>
         <Authors>https://github.com/jinek/Consolonia/graphs/contributors</Authors>
         <Description>Text User Interface implementation of Avalonia UI (GUI Framework)</Description>
         <Copyright>Copyright © Evgeny Gorbovoy 2021 - 2022</Copyright>

src/Consolonia.Core/Consolonia.Core.csproj

@@ -14,7 +14,7 @@
 
     <ItemGroup>
         <None Include="../../Icon.png" Pack="True" PackagePath="\" />
-        <None Include="readme.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>

src/Consolonia.Core/Infrastructure/ConsoloniaApplication.cs

@@ -1,5 +1,7 @@
+using System;
 using Avalonia;
 using Avalonia.Controls;
+using Avalonia.Controls.ApplicationLifetimes;
 using Avalonia.Controls.Primitives;
 using Avalonia.Input;
 using Avalonia.Media;
@@ -59,4 +61,16 @@ public override void OnFrameworkInitializationCompleted()
             }
         }
     }
+
+    public class ConsoloniaApplication<TMainWindow> : ConsoloniaApplication
+        where TMainWindow: Window
+    {
+        public override void OnFrameworkInitializationCompleted()
+        {
+            if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
+                desktop.MainWindow = Activator.CreateInstance<TMainWindow>();
+
+            base.OnFrameworkInitializationCompleted();
+        }
+    }
 }

src/Consolonia.Core/README.md

@@ -3,7 +3,60 @@ TUI (Text User Interface) (GUI Framework) implementation for [Avalonia UI](https
 
 Supports XAML, data bindings, animation, styling and the rest from Avalonia.
 
-## Showcase (click picture to see video)
+# Showcase (click picture to see video)
 [![datagridpic](https://user-images.githubusercontent.com/10516222/141980173-4eb4057a-6996-45bf-83f6-931316c98d88.png)](https://youtu.be/ttgZmbruk3Y)
 
-This package is the core Consolonia support.
+This package is the core Consolonia library.
+
+# Usage
+Define an application with a theme (See Consolonia.Themes.TurboVision for themes)
+
+## Define a Window
+HelloWorldWindow.axaml
+```xaml
+<Window xmlns="https://github.com/avaloniaui"
+        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+        x:Class="HelloWorldWindow">
+    <TextBlock Text="Hello World">
+</Window>
+```
+
+## Define an application 
+You need to define an application that defines a theme and sets the main window.
+
+HelloWorldApp.cs
+```csharp
+// use HelloWorldWindow as the MainWindow for the application
+public class HelloWorldApp : ConsoloniaApplication<HelloWorldWindow>
+{
+    public override void Initialize()
+    {
+        // set the theme
+        Styles.Add(new MaterialTheme());
+    }
+}
+```
+
+
+## Setup program.cs
+
+Program.cs
+```csharp
+[STAThread]
+private static void Main(string[] args)
+{
+    BuildAvaloniaApp()
+        .StartWithConsoleLifetime(args);
+}
+
+public static AppBuilder BuildAvaloniaApp()
+    => AppBuilder.Configure<HelloWorldApp>()
+        .UseConsolonia()
+        .UseAutoDetectedConsole()
+        .LogToException();
+```
+
+> **NOTE:** 
+> * You need package **Consolonia**.**Themes**.**TurboVision** for themes
+> * You need package **Consolonia**.**PlatformSupport** to add an IConsole implementation via the .UseAutoDetectedConsole() method
+ 

src/Consolonia.Designer/ConsolePreview.cs

@@ -2,7 +2,6 @@
 
 using Avalonia;
 using Avalonia.Controls;
-#if DEBUG
 using Consolonia.PreviewHost;
 using System;
 using System.Diagnostics;
@@ -15,7 +14,6 @@
 using Avalonia.Threading;
 using Consolonia.Core.Drawing.PixelBufferImplementation;
 using Newtonsoft.Json;
-#endif
 
 namespace Consolonia.Designer
 {
@@ -45,7 +43,6 @@ public class ConsolePreview : UserControl
 
         public ConsolePreview()
         {
-#if DEBUG
             _process = null;
             FontFamily = FontFamily.Parse("Cascadia Mono");
             Initialized += (_, _) => LoadXaml();
@@ -54,7 +51,6 @@ public ConsolePreview()
             {
                 if (e.Property == FileNameProperty) LoadXaml();
             };
-#endif
         }
 
 
@@ -102,7 +98,6 @@ protected void Dispose(bool disposing)
                 if (disposing)
                 {
                     // TODO: dispose managed state (managed objects)
-#if DEBUG
 #pragma warning disable CA1416 // Validate platform compatibility
                     if (_process != null)
                     {
@@ -111,7 +106,6 @@ protected void Dispose(bool disposing)
                         _process = null;
                     }
 #pragma warning restore CA1416 // Validate platform compatibility
-#endif
                 }
 
                 _disposedValue = true;
@@ -125,14 +119,10 @@ public void Dispose()
             Dispose(true);
         }
 
-#if DEBUG
         private Process? _process;
         private readonly Typeface _typeface = new("Cascadia Mono");
         private double _charWidth;
         private double _charHeight;
-#endif
-
-#if DEBUG
 
         private void LoadXaml()
         {
@@ -451,6 +441,5 @@ public void Flush()
                 _textRunCharWidth = 0;
             }
         }
-#endif
     }
 }

src/Consolonia.Designer/Consolonia.Designer.csproj

@@ -1,7 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Core.Build.props', '$(MSBuildThisFileDirectory)../'))" />
-
+    <PropertyGroup>
+        <IsPackable>false</IsPackable>
+    </PropertyGroup>
+
     <ItemGroup>
         <PackageReference Include="Avalonia" Version="$(AvaloniaVersion)" />
         <PackageReference Include="Avalonia.FreeDesktop" Version="$(AvaloniaVersion)" />
@@ -17,7 +20,7 @@
 
     <ItemGroup>
         <None Include="../../Icon.png" Pack="True" PackagePath="\" />
-        <None Include="readme.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>

src/Consolonia.Designer/Extensions.cs

@@ -19,13 +19,11 @@ public static class Extensions
         /// </remarks>
         public static AppBuilder UseConsoloniaDesigner(this AppBuilder builder)
         {
-#if DEBUG
-            if (Design.IsDesignMode) //AppDomain.CurrentDomain.FriendlyName == "Avalonia.Designer.HostApp")
+            if (Design.IsDesignMode) 
                 return builder
                     .UsePlatformDetect()
                     .WithInterFont()
                     .LogToTrace();
-#endif
 
             return builder.UseConsolonia();
         }

src/Consolonia.Designer/README.md

@@ -6,4 +6,21 @@ Supports XAML, data bindings, animation, styling and the rest from Avalonia.
 ## Showcase (click picture to see video)
 [![datagridpic](https://user-images.githubusercontent.com/10516222/141980173-4eb4057a-6996-45bf-83f6-931316c98d88.png)](https://youtu.be/ttgZmbruk3Y)
 
-This package is the Consolonia support for design time previews.
+This package **EXPERIMENTAL** Consolonia support for design time previews.
+
+## Usage
+```csharp
+[STAThread]
+private static void Main(string[] args)
+{
+    BuildAvaloniaApp()
+        .StartWithConsoleLifetime(args);
+}
+
+public static AppBuilder BuildAvaloniaApp()
+    => AppBuilder.Configure<App>()
+        .UseConsoloniaDesigner()
+        .UseAutoDetectedConsole()
+        .LogToException();
+```
+

src/Consolonia.Gallery/App.cs

@@ -5,7 +5,7 @@
 using Avalonia.Styling;
 using Consolonia.Core.Infrastructure;
 using Consolonia.Gallery.View;
-using Consolonia.Themes.TurboVision.Themes.Material;
+using Consolonia.Themes.TurboVision.Themes;
 
 namespace Consolonia.Gallery
 {
@@ -19,9 +19,9 @@ static App()
 
         public App()
         {
-            // Styles.Add(new TurboVisionTheme(new Uri("avares://Consolonia.Themes.TurboVision/Themes/TurboVisionDark/TurboVisionDark.axaml")));
-            Styles.Add(new MaterialTheme(new Uri("avares://Consolonia.Themes.TurboVision/Themes/Material/Material.axaml")));
-            // Styles.Add(new FluentTheme(new Uri("avares://Consolonia.Themes.TurboVision/Themes/Fluent/Fluent.axaml")));
+            // Styles.Add(new TurboVisionTheme());
+            Styles.Add(new MaterialTheme());
+            // Styles.Add(new FluentTheme());
         }
 
         public override void RegisterServices()

src/Consolonia.NUnit/Consolonia.NUnit.csproj

@@ -13,7 +13,7 @@
 
     <ItemGroup>
         <None Include="../../Icon.png" Pack="True" PackagePath="\" />
-        <None Include="readme.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>

src/Consolonia.NUnit/README.md

@@ -9,6 +9,35 @@ Supports XAML, data bindings, animation, styling and the rest from Avalonia.
 ## Showcase (click picture to see video)
 [![datagridpic](https://user-images.githubusercontent.com/10516222/141980173-4eb4057a-6996-45bf-83f6-931316c98d88.png)](https://youtu.be/ttgZmbruk3Y)
 
-Example of usage: https://github.com/jinek/ToolUI
+This package provides testing support for testing consolonia controls using NUnit.
 
-Solution contains one more readme file with coding information.
+## Usage
+To create a unit test against your consolonia application your test class should derive from ConsoloniaAppTestBase<App$gt;.
+
+You can define the size of your console by passing size parameter to base class.
+
+Then you can use UITest to interact with your application, and use UITest.AssertHasText() to verify the screen of text matches your expectation.
+
+### UITest.AssertHasText()
+Takes one or more Regex patterns and verifies that the screen contains the text that matches the pattern.
+
+### UITest.AssertHasNoText()
+Takes one or more Regex patterns and verifies that the screen does not contain the text that matches the pattern.
+
+## Example
+```csharp
+    public class Tests : ConsoloniaAppTestBase<App>
+    {
+        public Tests : base(new PixelBufferSize(80, 40))
+        {
+        }
+
+
+        [Test]
+        public async Task DisplaysBasicText()
+        {
+            await UITest.KeyInput(Key.Tab);
+            await UITest.AssertHasText("This is TextBlock");
+        }
+    }
+```

src/Consolonia.PlatformSupport/Consolonia.PlatformSupport.csproj

@@ -11,7 +11,7 @@
 
     <ItemGroup>
         <None Include="../../Icon.png" Pack="True" PackagePath="\" />
-        <None Include="readme.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
     <!-- 

src/Consolonia.PlatformSupport/README.md

@@ -9,6 +9,14 @@ Supports XAML, data bindings, animation, styling and the rest from Avalonia.
 ## Showcase (click picture to see video)
 [![datagridpic](https://user-images.githubusercontent.com/10516222/141980173-4eb4057a-6996-45bf-83f6-931316c98d88.png)](https://youtu.be/ttgZmbruk3Y)
 
-Example of usage: https://github.com/jinek/ToolUI
+This package provides Consolonia IConsole platform support for adapting to consoles on Windows, Linux and MacOS environments.
 
-Solution contains one more readme file with coding information.
+## Usage
+```csharp
+AppBuilder BuildAvaloniaApp()
+{
+    return AppBuilder.Configure<App>()
+        .UseConsolonia()
+        .UseAutoDetectedConsole();
+}
+```

src/Consolonia.Themes.TurboVision/Consolonia.Themes.TurboVision.csproj

@@ -12,7 +12,7 @@
 
     <ItemGroup>
         <None Include="../../Icon.png" Pack="True" PackagePath="\" />
-        <None Include="readme.md" Pack="true" PackagePath="\" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>

src/Consolonia.Themes.TurboVision/README.md

@@ -9,6 +9,9 @@ Supports XAML, data bindings, animation, styling and the rest from Avalonia.
 ## Showcase (click picture to see video)
 [![datagridpic](https://user-images.githubusercontent.com/10516222/141980173-4eb4057a-6996-45bf-83f6-931316c98d88.png)](https://youtu.be/ttgZmbruk3Y)
 
-Example of usage: https://github.com/jinek/ToolUI
-
-Solution contains one more readme file with coding information.
+This package defines 4 themes for Consolonia
+* **MaterialTheme** - Material Design
+* **FluentTheme** - Fluent Design
+* **TurboVisionTheme** - Turbo Vision
+* **TurboVisionDarkTheme** - Turbo Vision Dark
+* **TurboVisionBlackTheme** - Turbo Vision Black

src/Consolonia.Themes.TurboVision/Themes/Fluent/FluentTheme.cs → src/Consolonia.Themes.TurboVision/Themes/FluentTheme.cs

@@ -2,11 +2,14 @@
 using System.Diagnostics.CodeAnalysis;
 using Consolonia.Core.Styles;
 
-namespace Consolonia.Themes.TurboVision.Themes.Fluent
+namespace Consolonia.Themes
 {
     [SuppressMessage("ReSharper", "UnusedMember.Global")]
     public class FluentTheme : ResourceIncludeBase
     {
+        public FluentTheme() : base(new Uri("avares://Consolonia.Themes.TurboVision/Themes/Fluent/Fluent.axaml"))
+        {
+        }
         public FluentTheme(Uri baseUri) : base(baseUri)
         {
         }

src/Consolonia.Themes.TurboVision/Themes/Material/MaterialTheme.cs → src/Consolonia.Themes.TurboVision/Themes/MaterialTheme.cs

@@ -2,11 +2,15 @@
 using System.Diagnostics.CodeAnalysis;
 using Consolonia.Core.Styles;
 
-namespace Consolonia.Themes.TurboVision.Themes.Material
+namespace Consolonia.Themes
 {
     [SuppressMessage("ReSharper", "UnusedMember.Global")]
     public class MaterialTheme : ResourceIncludeBase
     {
+        public MaterialTheme() : base(new Uri("avares://Consolonia.Themes.TurboVision/Themes/Material/Material.axaml"))
+        {
+        }
+
         public MaterialTheme(Uri baseUri) : base(baseUri)
         {
         }