Skip to content
master
Go to file
Code

Latest commit

Federico Mena Quintero
Remove ignore from doctests

See merge request GNOME/librsvg!411
efad37c

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
m4
 
 
po
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Librsvg

This is librsvg - A small library to render Scalable Vector Graphics (SVG), associated with the GNOME Project. It renders SVG files to Cairo surfaces. Cairo is the 2D, antialiased drawing library that GNOME uses to draw things to the screen or to generate output for printing.

Do you want to render non-animated SVGs to a Cairo surface with a minimal API? Librsvg may be adequate for you.

GITHUB WILL DELETE YOUR PULL REQUESTS! We use gitlab.gnome.org instead. Please see CONTRIBUTING.md for details.

Using librsvg

Compiling: Librsvg uses a mostly normal autotools setup. You may run into some peculiarities due to the Rust internals library if you are cross-compiling or if you are in a build system with no network access, or if you are building binary packages from a librsvg tarball. In those cases, please refer to the COMPILING.md file.

Documentation: You can read the documentation for librsvg's C API or the Rust API. Please file an issue if you don't find something there that you need.

Bug tracking: If you have found a bug, take a look at our bug tracker. Please see the "reporting bugs" section in the file CONTRIBUTING.md to see how to provide a good bug report.

Asking questions: Feel free to ask questions about using librsvg in the desktop-devel-list mailing list.

Programming languages: Librsvg exports its API through GObject Introspection. This way, it is available in many programming languages other than C. Please see your language binding's documentation for information on how to load the Rsvg namespace.

Contributing to librsvg's development

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 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. Many projects which casually need to render static SVG images use librsvg.

We aim to be a "render this SVG for me, quickly, and with a minimal API" kind of library.

Feature additions will be considered on a case-by-case basis.

Non-goals of librsvg

We don't aim to:

  • Implement every single SVG feature that is in the spec.

  • Implement scripting or 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 would be glad to know!)

  • Replace the industrial-strength SVG rendering machinery in modern web browsers.

Of course, contributions are welcome. In particular, if you find nice ways of doing the above while still maintaining the existing API of librsvg, we would love to know about it!

Who uses librsvg?

Librsvg is part of the GNOME platform. Inside GNOME, librsvg takes multiple roles:

  • Loads SVGs from the generic gdk-pixbuf loader infrastructure, so any application which uses gdk-pixbuf can load SVGs as if they were raster images.

  • Loads SVG icons for the desktop.

  • Creates SVG thumbnails for the file manager.

  • Loads SVGs within GNOME's default image viewer, Eye of Gnome.

Outside of GNOME's core:

  • GNOME games (chess, five-or-more, etc. to draw game pieces)

  • GIMP

  • GCompris

  • Claws-mail

  • Darktable

  • Mate-panel

  • Evas/Enlightenment

  • Emacs

  • ImageMagick

  • Wikipedia, to render SVGs as raster images for old browsers. Special thanks to Wikimedia for providing excellent bug reports.

Presentations on librsvg

"Replacing C library code with Rust: What I learned with librsvg" was presented at GUADEC 2017. It gives a little history of librsvg, and how/why it is being ported to Rust from C.

"Patterns of refactoring C to Rust: the case of librsvg" was presented at GUADEC 2018. It describes ways in which librsvg's C code was refactored to allow porting it to Rust.

Maintainers

The maintainer of librsvg is Federico Mena Quintero. Feel free to contact me for any questions you may have about librsvg, both its usage and its development. You can contact me in the following ways:

  • Mail me at federico@gnome.org.

  • IRC: I am federico on irc.gnome.org in the #rust or #gnome-hackers channels. I'm there most weekdays (Mon-Fri) starting at about UTC 14:00 (that's 08:00 my time; I am in the UTC-6 timezone). If this is not a convenient time for you, feel free to mail me and we can arrange a time.

You can’t perform that action at this time.