summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@gnome.org>2017-06-26 21:03:37 -0500
committerFederico Mena Quintero <federico@gnome.org>2017-06-26 21:03:37 -0500
commit77e296fd852597359bfc973e0778269132474072 (patch)
tree31de764201ff39e70fb3ac858de142cd84f398b9 /README.md
parenta7e1953a343459762f362a069b6024567c8dda06 (diff)
downloadlibrsvg-77e296fd852597359bfc973e0778269132474072.tar.gz
Move README to README.md and mark it up a bit
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d3305f4a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+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`.
+
+For information on how to report bugs, or how to contribute to librsvg
+in general, please see the file `CONTRIBUTING.md`.
+
+Goals of librsvg
+----------------
+
+Librsvg aims to be a low-footprint library for rendering SVG images.
+It is used primarily in the [GNOME project](https://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.