From d923b6d2082daa7605487a93f7f867ecc5054e94 Mon Sep 17 00:00:00 2001 From: gregory guy Date: Tue, 25 Aug 2020 13:57:07 +0200 Subject: Rework of the help page. Add a screenshot. Signed-off-by: gregory guy --- doc/en/CMakeLists.txt | 2 +- doc/en/index.docbook | 94 +++++++++++++++----------------------------------- doc/en/screenshot.png | Bin 0 -> 14577 bytes 3 files changed, 28 insertions(+), 68 deletions(-) create mode 100644 doc/en/screenshot.png (limited to 'doc') diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt index de864ad..192dddc 100644 --- a/doc/en/CMakeLists.txt +++ b/doc/en/CMakeLists.txt @@ -1,7 +1,7 @@ file( GLOB _files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.html ) install( - FILES ${_files} kpacman.gif + FILES ${_files} kpacman.gif screenshot.png DESTINATION ${HTML_INSTALL_DIR}/en/${PROJECT_NAME} ) diff --git a/doc/en/index.docbook b/doc/en/index.docbook index c039dc5..d70e3b1 100644 --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -117,8 +117,12 @@ problems. Basically a long version of the abstract. Don't include a revision history. (see installation appendix comment) --> -&kapp; is a program that lets you do absolutely nothing. Please report -any problems or feature requests to the KDE mailing lists. +&kapp; is a classic arcade game from the 80s in which you have +to finish the tables by eating all the pac-gums (dots) to score as many points +as possible. + +Eat the dots and escape the ghosts with our hero. +You can eat the big spot when needed and eat the ghosts when the color changes. @@ -128,7 +132,8 @@ any problems or feature requests to the KDE mailing lists. - +Use the arrows from the keyboard to move &kapp;. +Here is a screenshot of the game. - - - Screenshot @@ -150,27 +152,6 @@ patent issues. --> - - -More Kapp features - -It slices! It dices! and it comes with a free toaster! - -The Stquiggle Tool - - - - - - - - Stquiggle - - is used to draw stquiggly lines all over -the &kpacman; main window. It's not a bug, it's a feature! - - - @@ -236,8 +217,7 @@ used for apps that use plugins or that provide their own scripting hooks and/or development libraries. --> -Programming &kpacman; plugins is a joy to behold. Just read through the next -66 pages of API's to learn how! +Doc to make plugins has yet to be written... My Mouse doesn't work. How do I quit &kapp;? -You silly goose! Check out the Commands +Please Check out the Commands Section for the answer. - - -Why can't I twiddle my documents? - - -You can only twiddle your documents if you have the foobar.lib -installed. - - @@ -338,11 +309,9 @@ Documentation copyright 1999 George N. Ugnacious gnu@kde.org How to obtain Kpacman -&kpacman; is part of the KDE project -http://www.kde.org. -&kpacman; can be found in the tdeutils package on -ftp://ftp.kde.org/pub/kde/, the -main ftp site of the KDE project. +&kpacman; is part of the TDE project +https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman. + @@ -360,22 +329,19 @@ information here. --> -In order to successfully use &kpacman;, you need KDE 1.1. Foobar.lib is required -in order to support the advanced &kpacman; features. &kpacman; uses about 5 megs of -memory to run, but this may vary depending on your platform and -configuration. +In order to successfully build &kapp;, the tdelibs and libtdegames libraries from the TDE project are required. -All required libraries as well as &kpacman; itself can be found -on The &kpacman; home page. +All required libraries as well as &kapp; itself can be found +on The TDE's home dev page. -You can find a list of changes at http://apps.kde.org/kapp. +You can find a list of changes (not currently updated) at Changelog. @@ -383,25 +349,19 @@ url="http://apps.kde.org/kapp">http://apps.kde.org/kapp. Compilation and Installation -In order to compile and install KApp on your system, type the following in the base -directory of the Icon Editor distribution: +In order to compile and install &kapp; on your system, type the following in the base +directory of the &kapp; sources: -% ./configure -% make -% make install +% mkdir -p build +% cd build +% cmake ../ +% make V=1 +# make install -Since KApp uses autoconf and automake you should have not trouble compiling it. -Should you run into problems please report them to the KDE mailing lists. - - - - -Configuration - -Don't forget to tell your system to start the dtd -dicer-toaster daemon first, or KApp won't work ! +Since &kapp; uses Cmake, you should have not trouble compiling it. + Please have a look on the 'install' file for more options. diff --git a/doc/en/screenshot.png b/doc/en/screenshot.png new file mode 100644 index 0000000..3e8ddb3 Binary files /dev/null and b/doc/en/screenshot.png differ -- cgit v1.2.1