[librsvg/rustification] Update the README



commit b518bba6be7234333c94c11330e15937bb2957ce
Author: Federico Mena Quintero <federico gnome org>
Date:   Wed Oct 26 18:18:46 2016 -0500

    Update the README

 README |   56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 54 insertions(+), 2 deletions(-)
---
diff --git a/README b/README
index 8460112..073b2ed 100644
--- a/README
+++ b/README
@@ -1,5 +1,57 @@
-This is librsvg - A high performance SVG rendering library associated with the Gnome Project.
+Librsvg
+=======
+
+This is librsvg - A small SVG rendering library associated with the
+GNOME Project.
+
+Do you want to render non-animated SVGs to a Cairo surface with a
+minimal, no-nonsense API?  Librsvg may be adequate for you.
+
+There is a code of conduct for contributors to librsvg; please see the
+file code_of_conduct.md.
+
+Reporting bugs
+--------------
 
 Please report bugs at http://bugzilla.gnome.org/enter_bug.cgi?product=librsvg
 
-There is a code of conduct for contributors to librsvg; please see the file code_of_conduct.md.
+If you want to report a rendering bug, or a missing SVG feature,
+please provide an example SVG file as an attachment to your bug
+report.  It really helps if you can minimize the SVG to only the
+elements required to reproduce the bug or see the missing feature, but
+it is not absolutely required.  Please be careful of publishing SVG
+images that you don't want other people to see; the bug tracker is a
+public resource and attachments are visible to everyone.
+
+Goals of librsvg
+----------------
+
+Librsvg aims to be a low-footprint library for rendering SVG images.
+It is used primarily in the GNOME project (www.gnome.org) to render
+SVG icons and vector images that appear on the desktop.  It is also
+used in Wikimedia to render the SVG images that appear in Wikipedia,
+so that even old web browsers can display them.
+
+We aim to be a "render this SVG for me, quickly, and with a minimal
+API" kind of library.  The SVG specification is huge, and definitely
+contains features that are not frequently used in the Real World, if
+at all.
+
+Feature additions will be considered on a case-by-case basis.  Extra
+points if you provide a proof-of-concept patch, and an example of the
+situation in which you encountered that missing feature!
+
+Non-goals of librsvg
+--------------------
+
+We don't aim to:
+
+* Implement every single SVG feature that is in the spec.
+
+* Implement external access to the SVG's DOM.
+
+* Implement support for CSS-based animations (but if you can think of
+  a nice API to do this, we'd be glad to know!)
+
+* Replace the industrial-strength SVG rendering machinery in modern
+  web browsers.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]