From df63f013cef0f13c02e9db7c5fed11ddc73bb9c6 Mon Sep 17 00:00:00 2001 From: "opencode-agent[bot]" Date: Mon, 16 Feb 2026 02:16:16 +0000 Subject: [PATCH] docs: add project README --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d3df00a --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Ink Canvas Next + +A revolutionary desktop drawing application built with Avalonia and .NET, featuring Windows 11 Fluent Design. + +## Features + +- **Drawing Tools**: Pen, Highlighter, and Eraser +- **Color Palette**: 8 preset colors (Black, Red, Blue, Green, Orange, Purple, Yellow, White) +- **Adjustable Pen Size**: 1-20px +- **Background Modes**: Transparent, Whiteboard, Blackboard +- **Modern UI**: Windows 11 Fluent Design with borderless fullscreen window + +## Tech Stack + +- **Framework**: Avalonia 11.3.11 +- **Language**: C# (.NET 10.0) +- **UI Pattern**: MVVM (CommunityToolkit.Mvvm) +- **Theme**: FluentAvaloniaUI 2.5.0 +- **Drawing**: DotNetCampus.AvaloniaInkCanvas + SkiaSharp + +## Building + +```bash +cd Ink-Canvas-Next +dotnet build +``` + +## Running + +```bash +dotnet run +``` + +## Project Structure + +``` +Ink-Canvas-Next/ +├── Ink-Canvas-Next/ +│ ├── ViewModels/ +│ │ ├── ViewModelBase.cs +│ │ └── MainWindowViewModel.cs +│ ├── Views/ +│ │ ├── MainWindow.axaml +│ │ └── MainWindow.axaml.cs +│ ├── App.axaml +│ ├── App.axaml.cs +│ ├── Program.cs +│ ├── ViewLocator.cs +│ └── Ink-Canvas-Next.csproj +└── Ink Canvas Next.slnx +``` + +## License + +MIT