Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sketchnow/sketchnow.wpf

A application brings the ability to draw on your screen
https://github.com/sketchnow/sketchnow.wpf

annotation annotation-tool csharp inkcanvas material-design mvvm-pattern velopack windows wpf

Last synced: 10 days ago
JSON representation

A application brings the ability to draw on your screen

Host: GitHub
URL: https://github.com/sketchnow/sketchnow.wpf
Owner: SketchNow
License: mit
Created: 2024-10-11T10:11:12.000Z (26 days ago)
Default Branch: main
Last Pushed: 2024-10-24T01:25:35.000Z (13 days ago)
Last Synced: 2024-10-24T15:22:20.173Z (13 days ago)
Topics: annotation, annotation-tool, csharp, inkcanvas, material-design, mvvm-pattern, velopack, windows, wpf
Language: C#
Homepage:
Size: 426 KB
Stars: 3
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # SketchNow

[![Issues](https://img.shields.io/github/issues/SketchNow/SketchNow.WPF.svg)](https://github.com/SketchNow/SktechNow.WPF/issues)

A application brings the ability to draw on your screen(anywhere)

> [!CAUTION]

> Still developing. To avoid potential risks, please don't install in the production environment

![Screenshot of you are using a desktop application with SketchNow](screenshot.png)

### Install

Go [release](https://github.com/SketchNow/SketchNow.WPF/releases), and choose the version you want.

If you want have a taste of the latest commited code, you can go [actions](https://github.com/SketchNow/SketchNow.WPF/actions), and download the `app` of all `artifacts`  

### Contribute

1. Follow the `.editorconfig`

2. Use `Xaml Styler` to format xaml (Xaml Styler file at [Settings.XamlStyler](Settings.XamlStyler))

3. Follow [`Conventional Commits`](https://www.conventionalcommits.org/en/v1.0.0/)

4. Follow [`Semantic Versioning`](https://semver.org/)

### Build

- Windows 10 or greater

- Visual Studio 2022/JetBrains Rider

- .NET Desktop workload with `.NET 8`

### Publish

We are using [Velopack](https://github.com/velopack/velopack) to generate release

Before you using following commands, please ensure that you have read [this](https://docs.velopack.io/getting-started/csharp)

```shell

dotnet publish -c Release --self-contained -r win-x64 -o .\publish

```

```shell

vpk pack -u SketchNow -v 1.0.0 -p .\publish -e SketchNow.exe

```

### Test

- Moq.AutoMocker

### Credit

- [DotnetTemplates](https://github.com/Keboo/DotnetTemplates)

- [wpf](https://github.com/dotnet/wpf)

- [CommunityToolkit MVVM](https://github.com/CommunityToolkit/dotnet)

- [Material Design in XAML](https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit)

- [ValueConverters.NET](https://github.com/thomasgalliker/ValueConverters.NET)

- [WPF.JoshSmith.Controls.DragCanvas](https://github.com/denxorz/WPF.JoshSmith.Controls.DragCanvas)

- [Velopack](https://github.com/velopack/velopack)

- Moq.AutoMocker

- System.Text.Json

- Microsoft.Extensions.Hosting

- Microsoft.Extensions.DependencyInjection