diff --git a/CMakeLists.txt b/CMakeLists.txt index 9b4a7d1d..fbf1b04d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,61 +1,62 @@ cmake_minimum_required(VERSION 3.6) project(elisa) set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_STANDARD 14) set(REQUIRED_QT_VERSION "5.6.0") find_package(Qt5 ${REQUIRED_QT_VERSION} CONFIG REQUIRED Core Network Xml Qml Sql Multimedia Svg Gui) find_package(Qt5 ${REQUIRED_QT_VERSION} CONFIG QUIET OPTIONAL_COMPONENTS Quick Widgets Test DBus WebSockets) find_package(ECM 5.24.0 REQUIRED NO_MODULE) set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR}) include(KDEInstallDirs) include(KDEFrameworkCompilerSettings) include(KDECMakeSettings) find_package(KF5I18n CONFIG REQUIRED QUIET) find_package(KF5Declarative CONFIG QUIET) find_package(KF5CoreAddons CONFIG QUIET) find_package(KF5Baloo CONFIG QUIET) find_package(KF5FileMetaData CONFIG QUIET) find_package(KDSoap CONFIG QUIET) find_package(UPNPQT CONFIG QUIET) find_package(KF5Kirigami CONFIG QUIET) include(FeatureSummary) include(GenerateExportHeader) include(ECMSetupVersion) include(ECMGenerateHeaders) include(CMakePackageConfigHelpers) if (CMAKE_SYSTEM_NAME STREQUAL Android) set(QT_QMAKE_EXECUTABLE "$ENV{Qt5_android}/bin/qmake") # workaround until this fix is in released ECM if(ECM_VERSION VERSION_LESS "5.24.0") add_definitions(-DANDROID) endif() endif() configure_file(config-upnp-qt.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-upnp-qt.h ) add_subdirectory(src) add_subdirectory(autotests) +add_subdirectory(doc) install( PROGRAMS org.kde.elisa.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} ) install( FILES org.kde.elisa.appdata.xml DESTINATION ${KDE_INSTALL_METAINFODIR} ) feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 00000000..ba4a0a82 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,7 @@ +# documentation + +KDOCTOOLS_CREATE_HANDBOOK( + index.docbook + INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en + SUBDIR elisa +) diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 00000000..927fbadb --- /dev/null +++ b/doc/index.docbook @@ -0,0 +1,416 @@ + +Elisa"> + Elisa"> + + +]> + + + + + +The &elisa; Handbook + + + + +Matthieu +Ugnacious + +matthieu_gallien@yahoo.fr + + + + + +2017 +Matthieu Gallien + +&FDLNotice; + +2017-02-11 + + +Elisa 0.1 + + + + + +&elisa; is a music player designed to be simple to use. + + + + +KDE +kdemultimedia +Elisa +audio +music + + + + + +Introduction + + +&elisa; is a music player designed to be simple to use. + + + + +Using &elisa; + + + + + + + + +Here's a screenshot of &elisa; + + + + + + Screenshot + + + + + + + +More &elisa; features + +It slices! It dices! and it comes with a free toaster! + +The Squiggle Tool + + + + + Squiggle + + is used to draw squiggly lines all over +the &elisa; main window. It's not a bug, it's a feature! + + + + + + +Command Reference + + + + +The main &elisa; window + + +The File Menu + + + + + + +&Ctrl;N + +File +New + +Creates a new document + + + + + +&Ctrl;S + +File +Save + +Saves the document + + + + + +&Ctrl;Q + +File +Quit + +Quits &elisa; + + + + + + + + + +The Settings and Help Menu + +&elisa; has the common &kde; Settings and Help +menu items, for more information read the sections about the Settings Menu and Help Menu +of the &kde; Fundamentals. + + + + +The Help Menu + +&elisa; has the common &kde; Help menu item, for more information read the section +about the Help Menu of the &kde; Fundamentals. + + + + +Menu Items +Apart from the common &kde; menus described in the Menu +chapter of the &kde; Fundamentals documentation &elisa; has these application specific menu entries: + + + + + +The Help Menu +&elisa; has a default &kde; Help menu as described in the +&kde; Fundamentals +with two additional entries: + + + + + + + +Developer's Guide to &elisa; + + + + +Programming &elisa; plugins is a joy to behold. + + + + + + +Questions and Answers + + + + + + +My Mouse doesn't work. How do I quit &elisa;? + + +You silly goose! Check out the Commands +Section for the answer. + + + + +Why can I not twiddle my documents? + + +You can only twiddle your documents if you have the foobar.lib +installed. + + + + + + + + + +Credits and License + + +&elisa; + + +Program copyright 2010-2014 John Q. Hacker jqh@kde.org + + +Contributors: + +Konqui the &kde; Dragon konqui@kde.org + +Tux the &Linux; Penguin tux@linux.org + + + + + +Documentation Copyright © 2012-2014 George N. Ugnacious gnu@kde.org + + + + +&underFDL; + + + +&underGPL; +&underBSDLicense; +&underArtisticLicense; +&underX11License; + + + + + + +Installation + + +How to obtain &elisa; + + + +&install.intro.documentation; + + + + +Requirements + + + + +In order to successfully use &elisa;, you need few libraries from +&kf5; 5.1 (bar, baz). Foobar.lib is +required in order to support the advanced &elisa; features. &elisa; uses +about 5 megs of memory to run, but this may vary depending on your +platform and configuration. + + + +All required libraries as well as &elisa; itself can be found +on The &elisa; home page. + + + + +You can find a list of changes at http://apps.kde.org/kapp. + + + + +Compilation and Installation + + + + + +&install.compile.documentation; + + + + +Configuration + +Don't forget to tell your system to start the dtd +dicer-toaster daemon first, or &elisa; won't work! + + + + + +&documentation.index; + + +