From 6ac2f22144a366f35b8cb7d3741c5e3902f9cc01 Mon Sep 17 00:00:00 2001 From: mrbean-bremen Date: Sun, 2 Jun 2024 09:21:33 +0200 Subject: [PATCH] Slightly restructured README - added introductory sentence - moved history to separate sub-chapter --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f3f432730..feb0f56d7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ ![W3C SVG Logo](https://www.w3.org/Icons/SVG/svg-logo-v.png) # SVG.NET[![NuGet version](https://badge.fury.io/nu/svg.svg)](https://badge.fury.io/nu/svg) [![Gitter](https://badges.gitter.im/vvvv/SVG.svg)](https://gitter.im/vvvv/SVG?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ![Testsuite](https://github.com/svg-net/SVG/workflows/Testsuite/badge.svg?branch=master) ![DocBuild](https://github.com/svg-net/SVG/workflows/DocBuild/badge.svg?branch=master) -Public fork of the C# SVG rendering library on CodePlex. +SVG.NET is a C# library to read, write and render SVG 1.1 images in applications based on the .NET framework. -This started out as a private fork by [vvvv](https://vvvv.org) with some minor modification to enable the writing of proper SVG strings. -After almost two years of fixes and improvements the company decided to share the codebase with the public in order to improve it even further. -In 2021, the repository has been transferred from the company organization `vvvv` to the new organization `svg-net` (e.g. SVG.NET). +It is compatible with platforms implementing .NET Standard 2.0 and works under Windows, Linux, and macOS +(the latter two with some limitations with respect to rendering). + +SVG.NET is available as a NuGet package and can be referenced by any .NET application supporting .NET Standard 2.0. + +## Documentation +For information on installation and usage of the library, and for release notes please check the [documentation pages](https://svg-net.github.io/SVG/). +Note that the documentation is very rudimentory - any help to improve it is greatly appreciated! ## Contributing This project is in need of contributors. @@ -16,10 +21,11 @@ For those interested in leading or contributing to specific initiatives like the Please feel free to fork the repository and open pull requests for any fix, improvement or feature you want to add. You may check the [contributing guide](https://github.com/svg-net/SVG/blob/master/CONTRIBUTING.md) for more information on how to do this. -## Documentation -For information on installation and usage of the library, and for release notes please check the [documentation pages](https://svg-net.github.io/SVG/). -Note that the documentation is incomplete - any help to improve it is greatly appreciated! - +## History +This project is a public fork of the SVG.NET C# library originally created by Microsoft on (now defunct) CodePlex. +It started out as a private fork by [vvvv](https://vvvv.org) with some minor modification to enable the writing of proper SVG strings. +After almost two years of fixes and improvements the company decided to share the codebase with the public in order to improve it even further. +In 2021, the repository has been transferred from the company organization `vvvv` to the new organization `svg-net` (e.g. SVG.NET). ## Projects using the library