diff options
| author | Federico Mena Quintero <federico@gnome.org> | 2017-11-25 11:38:42 -0600 |
|---|---|---|
| committer | Federico Mena Quintero <federico@gnome.org> | 2017-11-25 11:38:42 -0600 |
| commit | b5986d8b00f79d79e47da9703fa3ffa6cce859c3 (patch) | |
| tree | dd3b94676ac9c0734ce4f9daef41ed1203b69257 /README.md | |
| parent | e56b240c02d3a32429bd3013ec08246e685a9f02 (diff) | |
| download | librsvg-b5986d8b00f79d79e47da9703fa3ffa6cce859c3.tar.gz | |
Make the toplevel README.md more hospitable
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 47 insertions, 2 deletions
@@ -2,13 +2,37 @@ Librsvg ======= This is librsvg - A small SVG rendering library associated with the -GNOME Project. +[GNOME Project][gnome]. It renders SVG files to [Cairo][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, no-nonsense API? Librsvg may be adequate for you. +Using librsvg +------------- + +**Documentation:** You can read the [documentation for librsvg][docs] at +developer.gnome.org. Please [tell us][mail] 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][bugs]. Please see the "[reporting bugs][reporting-bugs]" +section in the file [CONTRIBUTING.md][contributing] to see how to +provide a good bug report. + +**Asking questions:** Feel free to ask questions about using librsvg +in the [desktop-devel-list][d-d-l] mailing list. + +**Programming languages:** There are bindings for librsvg in +programming languages other than C: FIXME: include links to the +various bindings. + +Contributing to librsvg's development +------------------------------------- + There is a code of conduct for contributors to librsvg; please see the -file `code_of_conduct.md`. +file [`code_of_conduct.md`][coc]. For information on how to report bugs, or how to contribute to librsvg in general, please see the file `CONTRIBUTING.md`. @@ -45,3 +69,24 @@ We don't aim to: * Replace the industrial-strength SVG rendering machinery in modern web browsers. + +Of course, [contributions are welcome][contributing]. 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! + +Maintainers +----------- + +The maintainer of librsvg is [Federico Mena Quintero]. You can [mail +me][mail] for any other questions you have about librsvg. + +[gnome]: https://www.gnome.org/ +[cairo]: https://www.cairographics.org/ +[coc]: code-of-conduct.md +[docs]: https://developer.gnome.org/rsvg/stable/ +[mail]: mailto:federico@gnome.org +[bugs]: http://bugzilla.gnome.org/enter_bug.cgi?product=librsvg +[contributing]: CONTRIBUTING.md +[reporting-bugs]: CONTRIBUTING.md#reporting-bugs +[d-d-l]: https://mail.gnome.org/mailman/listinfo/desktop-devel-list +[federico]: https://people.gnome.org/~federico/ |