|
| 1 | +## About |
| 2 | + |
| 3 | +This project provides a C# library for parsing, converting and viewing the SVG files in WPF applications. |
| 4 | + |
| 5 | +More documentation is available at the [ShapeVectors Github Pages](https://github.com/ElinamLLC/SharpVectors/). |
| 6 | + |
| 7 | +> ### Marked for Retirement |
| 8 | +> This package naming of the SharpVectors library will be depreciated in Version 2.0. |
| 9 | +> Please see the **Related Packages** section for an alternatively named package. |
| 10 | +
|
| 11 | +## Key Features |
| 12 | + |
| 13 | +* Parsing of the SVG files to create the SVG DOM |
| 14 | +* SVG to XAML conversion |
| 15 | +* A small runtime library to handle font URI, embedded images and others when using the XAML files directly from disk. |
| 16 | +* An optimized XAML output. |
| 17 | +* Interaction with the conversion process (by a visitor pattern) to allow for custom hyper-link implementations, font substitutions etc. |
| 18 | +* Supports .NET Framework 4+, .NET Core, and .NET 6.0 |
| 19 | + |
| 20 | +## Main Components |
| 21 | + |
| 22 | +The library consists of several components as listed below and there is no dependency on external components: |
| 23 | + |
| 24 | +* `SharpVectors.Core.dll` (SVG interfaces and basic types) |
| 25 | +* `SharpVectors.Css.dll` (CSS interfaces and types) |
| 26 | +* `SharpVectors.Dom.dll` (SVG DOM, integrates CSS DOM) |
| 27 | +* `SharpVectors.Model.dll` (SVG model, parsing and utility classes) |
| 28 | +* `SharpVectors.Rendering.Gdi.dll` (GDI+ rendering of the SVG Model - requires more work) |
| 29 | +* `SharpVectors.Runtime.Wpf.dll` (An independent component with scroling/zooming panels for viewing rendered XAML) |
| 30 | +* `SharpVectors.Rendering.Wpf.dll` (WPF rendering of the SVG Model) |
| 31 | +* `SharpVectors.Converters.Wpf.dll` (Utitlity classes providing access to the WPF rendering features) |
| 32 | + |
| 33 | +## Credits |
| 34 | + |
| 35 | +SharpVectors uses source codes from articles and other open source projects. We wish to acknowledge and thank |
| 36 | +the authors of these great articles and projects |
| 37 | +* [SharpVectorGraphics (aka SVG#)](https://sourceforge.net/projects/svgdomcsharp/) by SVG# Team of Developers (SourceForge) |
| 38 | +* [WPF Zooming and Panning Control](https://www.codeproject.com/KB/WPF/zoomandpancontrol.aspx) by Ashley Davis (CodeProject) |
| 39 | +* [Render Text On A Path With WPF](https://msdn.microsoft.com/en-us/magazine/dd263097.aspx) by Charles Petzold (MSDN Magazine - December 2008) |
| 40 | +* [MinIoC](https://github.com/microsoft/MinIoC) by Microsoft (Single-file minimal C# IoC container) |
| 41 | +* [.NET ZLib Implementation](https://www.codeproject.com/Tips/830793/NET-ZLib-Implementation) by Alberto M (CodeProject) |
| 42 | +* [Brotli compression format](https://github.com/google/brotli) by Google (C# Decoder) |
| 43 | + |
| 44 | +## Related Packages |
| 45 | + |
| 46 | +* Full Package (WPF/GDI+) - Recommended: [SharpVectors](https://www.nuget.org/packages/SharpVectors/) |
| 47 | +* WPF Package (WPF Only) - Recommended for WPF: [ SharpVectors.Wpf](https://www.nuget.org/packages/SharpVectors.Wpf/) |
| 48 | + |
| 49 | +## Feedback |
| 50 | + |
| 51 | +SharpVectors is released as open source under the [BSD-3-Clause license](https://github.com/ElinamLLC/SharpVectors/blob/master/License.md), |
| 52 | +and the [Third-Party licences](https://github.com/ElinamLLC/SharpVectors/blob/master/License.txt) |
| 53 | + |
| 54 | +* Bug reports and contributions are welcome at [SharpVectors Issues](https://github.com/ElinamLLC/SharpVectors/issues/). |
| 55 | +* Discussions and Q/A are welcome at [SharpVectors Discussions](https://github.com/ElinamLLC/SharpVectors/discussions/). |
0 commit comments