mirror of
https://invent.kde.org/frameworks/kimageformats.git
synced 2025-05-28 00:30:23 -04:00
Fill out README.md file
Also delete the old README file, as README.md now contains the information from it.
This commit is contained in:
parent
8019c67d76
commit
7be60a7bd0
35
README.md
35
README.md
@ -1,7 +1,40 @@
|
||||
#
|
||||
# KImageFormats
|
||||
|
||||
## Introduction
|
||||
|
||||
This framework provides additional image format plugins for QtGui. As
|
||||
such it is not required for the compilation of any other software, but
|
||||
may be a runtime requirement for Qt-based software to support certain
|
||||
image formats.
|
||||
|
||||
See the src/imagesformats directory for the provided image formats.
|
||||
|
||||
## Contributing
|
||||
|
||||
See the QImageIOPlugin documentation for information on how to write a
|
||||
new plugin.
|
||||
|
||||
The main difference between this framework and the qimageformats module
|
||||
of Qt is the license. As such, if you write an imageformat plugin and
|
||||
you are willing to sign the Qt Project contributor agreement, it may be
|
||||
better to submit the plugin directly to the Qt Project.
|
||||
|
||||
Note that the imageformat plugins provided by this module also provide a
|
||||
desktop file. This is for the benefit of KImageIO in the KDE4 Support
|
||||
framework.
|
||||
|
||||
## Duplicated Plugins
|
||||
|
||||
The TGA plugin supports more formats than Qt's own TGA plugin;
|
||||
specifically, the one provided here supports indexed, greyscale and RLE
|
||||
images (types 1-3 and 9-11), while Qt's plugin only supports type 2
|
||||
(RGB) files.
|
||||
|
||||
The code for this cannot be contributed upstream directly because of
|
||||
licensing. If anyone were willing to write fresh code to improve Qt's
|
||||
TGA plugin, it would allow the TGA plugin in this framework to be
|
||||
removed.
|
||||
|
||||
## Links
|
||||
|
||||
- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
|
||||
|
@ -1,9 +0,0 @@
|
||||
This directory contains Qt imageformat plugins. See QImageIOPlugin docs
|
||||
for how to write a new handler.
|
||||
|
||||
It also contains desktop files for the plugins that come with Qt.
|
||||
|
||||
The TGA plugin supports more formats than Qt's own TGA plugin;
|
||||
specifically, the one provided here supports indexed, greyscale and RLE
|
||||
images (types 1-3 and 9-11), while Qt's plugin only supports type 2
|
||||
(RGB) files.
|
Loading…
Reference in New Issue
Block a user