From 07025193fd7347262d521128071bbcca9364d1a4 Mon Sep 17 00:00:00 2001 From: Ivailo Monev Date: Sat, 31 Oct 2015 13:16:55 +0200 Subject: [PATCH] README: replace with generic one Signed-off-by: Ivailo Monev --- README | 215 +++++---------------------------------------------------- 1 file changed, 19 insertions(+), 196 deletions(-) diff --git a/README b/README index 09aeec25..fcde8c64 100644 --- a/README +++ b/README @@ -1,203 +1,26 @@ -In this file: +### Katana - Be Free and Be Efficient! -* About kdelibs -* Licensing -* Common Mistakes -* Upgrading -* Compile Problems -* More Info +Katana is fork of KDE Software Distribution with emphasis on efficiency. So far +it has proven to be roughly 50% less system resource hungry and significantly +faster. +Try it via Live CD/DVD - http://www.entropy-linux.com/public/snapshots/. -About kdelibs -------------- -This package includes libraries that are central to the development and -execution of a KDE program, as well as internationalization files for these -libraries, misc HTML documentation, theme modules, and regression tests. +### Authors and Contributors -Here is an alphabetical list of all individual libraries: +Since Katana is a fork of someone else's work, many of the credits go to the KDE +Software Development team. So far there are not much people involved in this +project but we hope that the number will increase. -* dnssd - Interface to the DNS-SD (Zeroconf) support. +Software can always be improved, and the Katana team is ready to do so. +However, you - the user - must tell us when something does not work as +expected or could be done better. You do not have to be a software developer +to be a member of the Katana team. You can join the national teams that +translate program interfaces. You can provide graphics, themes, sounds, and +improved documentation. You decide! -* interfaces - kparts interface for text editors, mediaplayer and scripting. +### Support and Contact -* kate - KPart for 'kate', the KDE advanced text editor. - -* kdecore - This is the core collection of KDE stuff. Non GUI classes reside here. - -* kdesu - Library for password entering and handling - -* kdeui - The main collection of misc. user interface classes (widgets). - -* kdewidgets - For developers: KDE's custom widgets for Qt Designer. - -* kfile - File management widgets and dialogs. - -* kimgio - An all purpose extension to the qimgio class that supports various - image formats. - -* kio - Classes that fetch and decode URLs are contained here. This library also - contains "ksycoca", the system configure cache containing services, - applications, servicetypes and mimetypes. - -* knotify - Handles user notifications, including sounds, logging to files, etc. - -* kparts - KDE component model. - -* kpty - Abstraction layer for virtual consoles. - -* kross - Scripting host for KDE applications. - -* kutils - Utility library for printing, chatting and more. - -* plasma - Framework for the KDE 4 desktop shell and its widgets. - -* security - Certificate management and cryptography settings. - -* solid - Hardware detection. - -* sonnet - Tools for natural language processing, including spell and grammar check. - Includes gui widgets. - -* threadweaver - Job-based threading library. - -And here is an alphabetical list of all further parts of kdelibs: - -* cmake - Build system used throughout KDE. - -* includes - Qt-style include file wrappers. - -* kded - The KDE daemon checks for newly installed software, update files - or hostname changes and takes according actions. - -* kioslave - I/O subprocesses to handle files, ftp, http, gzip and bzip2 streams. - -* kinit - Process launcher (kdeinit), used for fast KDE startup and to launch kioslaves. - -* licenses - Contains texts of all used licenses. - -* mimetypes - Database of mime types. - -Licensing ---------- -The libraries themselves have been covered (since Saturday, June 21st, 1997) -by the GNU Library General Public License (LGPL). Any other programs (such -as the examples) are covered by the GNU General Public License (GPL). All -the gory details for the LGPL reside in COPYING.LIB, and for the GPL reside -in COPYING. - -Various parts are also covered under a BSD style license, detailed in -licenses/BSD. Currently, code covered under such license is copyrighted by -Theo de Raadt. - -When in doubt, check the individual file, they should all have license -headings and other identifying marks. - - -Common Mistakes ---------------- -If cmake claims Qt cannot be found, look at http://qt.nokia.com/ -to get a copy of Qt, version 4.8 or newer. If you have peeked there -already, grab the SVN module qt-copy from anonsvn.kde.org, or a snapshot -thereof. Alternatively the svn module qt-copy from svn.kde.org can also be -used. - -If you know you have the latest Qt 4, another reason it may not be able to -'find' QT is because it's finding an older version of QT 4. Make sure that -your PATH is set appropriately to find the qmake from the latest Qt 4, and -LD_LIBRARY_PATH is set to include $QTDIR/lib. - -Debugging ---------- -You can set the CMAKE_BUILD_TYPE option with the cmake, if you want to have -debug code in your KDE libs. If you have the space and can stand code that's -somewhat slower, this is worth it. The extra information really -helps debugging and thus bugfixing. - -Available options as of CMake 2.4.5: - Release: Compile with no debugging information, optimization enabled. - Debug: Minimal optimization, with debugging information. - RelWithDebInfo: Normal optimization, with debugging information. - MinSizeRel: No debugging information, with optimization for smallest size. - -e.g.: "cmake -DCMAKE_BUILD_TYPE=Debug" when running cmake. - -See also the file DEBUG. - - -Upgrading ---------- -KDE 4 applications will try to migrate settings where possible. - -Compile Problems ----------------- -Often, KDE compile failures are not KDE's fault, but the fault of the -compiler or the distribution used. For that reason, please have a look at -http://techbase.kde.org/Getting_Started/Build/FAQ for known issues in certain -OS environments before reporting bugs or going mad :). - -KDE 4 requires gcc 3.3 or better as the compiler. - -How to report -------------- -Reporting bugs is an art. Why? Because bug reports can help and hinder. - -They hinder if the developers are just buried in an avalanche of bug reports. -They spend hours figuring out which bug reports are valid and which aren't, -which bug reports are due to bugs or due to installation problems. - -They can be of tremendous help to notify developers on problems in areas that -they normally don't have access (e.g. KDE on AIX) to. - -So, here are some tips on bug reporting: - -* Make sure your bug is due to KDE ... and not due to a packaging problem of - your OS distributor. For example, most "I can not install the XYZ.rpm" - problem are due to packaging issues. Refer with such questions to your - OS Distributor and his appropriate mailing list or bug reporting tool. - -* The chance is high that your bug has already been dealt with ... so look - if there is a newer version of kdelibs available. Reporting bugs for - older, deprecated versions usually don't get that much attention :-) - -* Also the chance is high that another one experienced your problem. The - bug report wizard at http://bugs.kde.org/ will help you to find out if your - problem has already been reported. - -* KDE Applications come with a Report Bug option in the Help menu that will - fill out many of the forms on the bug reporter tool at http://bugs.kde.org/ - for you. - -* The best bug report for a project based on voluntary work is of course one - that comes with a patch that solves the problem. :-) - - -More info ---------- -https://github.com/fluxer/katana/wiki is a good starting point for info on KDE. +Check out the wiki at https://github.com/fluxer/katana/wiki for frequently asked +questions (FAQ) and other information. Feel free to report issues at +https://github.com/fluxer/katana/issues.