Git commit 6f37ca3d13df55eae387de746b5c4c092289615c by Minh Ngo. Committed on 03/04/2015 at 16:49. Pushed by minhngo into branch 'master'.
Adding small user documentation M +1 -1 AUTHORS M +2 -1 CMakeLists.txt A +4 -0 doc/CMakeLists.txt A +117 -0 doc/index.docbook A +- -- doc/screenshot.png M +4 -4 main.cpp http://commits.kde.org/kdots/6f37ca3d13df55eae387de746b5c4c092289615c diff --git a/AUTHORS b/AUTHORS index d8b5d0e..7ea5d61 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1 +1 @@ -Minh Ngo <nlminhtl at gmail.com> \ No newline at end of file +Minh Ngo <minh at fedoraproject.org> \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index 962d960..f9e1fe2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -58,4 +58,5 @@ install(PROGRAMS kdots.desktop DESTINATION ${XDG_APPS_INSTALL_DIR}) install(FILES cmake/KDotsLibConfig.cmake DESTINATION ${CMAKECONFIG_INSTALL_PREFIX}/KDotsLib) add_subdirectory(kdotslib) -add_subdirectory(plugins) \ No newline at end of file +add_subdirectory(plugins) +add_subdirectory(doc) \ No newline at end of file diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..c9d392f --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,4 @@ +########### install files ############### +# + +kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kdots) \ No newline at end of file diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 0000000..52e18db --- /dev/null +++ b/doc/index.docbook @@ -0,0 +1,117 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ + + <!ENTITY kappname "KDots"> + <!ENTITY package "kdegames"> + <!ENTITY latex "L<superscript>A</superscript>T<subscript>E</subscript>X"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> +<book id="KDots" lang="&language;"> + +<bookinfo> +<title>The KDots Handbook</title> + +<authorgroup> +<author> +<personname> +<firstname>Minh</firstname> +<surname>Ngo</surname> +</personname> +<email>minh at fedoraproject.org</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2015</year> +<holder>Minh Ngo</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2015-04-03</date> +<releaseinfo>0.5.4 (&kde; 5.8.0)</releaseinfo> + +<abstract> +<para> +KDots is a simple implementation of the game of dots written with Qt Toolkit and KDELibs. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>Board</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +KDots is a simple implementation of the game of dots written with Qt Toolkit and KDELibs. + +The purpose of the Dots game is to catch your opponent's dots by placing your dots on the +game board where the lines cross. + +Game mode can be extended via plugins. Currently, 3 plugins are available for supporting AI, +online and offline games between two players. +</para> +</chapter> + +<chapter id="using-kapp"> +<title>Using KDots</title> + +<para> +Screenshot: +<screenshot> +<screeninfo>Here is a screenshot of KDots</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para> +KDots +</para> +<para> +Program copyright 2011, 2012, 2014, 2015 Minh Ngo <email>minh at fedoraproject.org</email> +</para> + +<para> +Documentation Copyright © 2015 Minh Ngo <email>minh at fedoraproject.org</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> +&underGPL; <!-- GPL License --> +</chapter> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +vim:tabstop=2:shiftwidth=2:expandtab +kate: space-indent on; indent-width 2; tab-width 2; indent-mode none; +--> diff --git a/doc/screenshot.png b/doc/screenshot.png new file mode 100644 index 0000000..ef7ed9b Binary files /dev/null and b/doc/screenshot.png differ diff --git a/main.cpp b/main.cpp index e85bfbe..cef82da 100644 --- a/main.cpp +++ b/main.cpp @@ -38,11 +38,11 @@ void initAboutData(KAboutData& aboutData) { aboutData.setHomepage("https://github.com/Ignotus/kdots";); - aboutData.setBugAddress("nlminhtl at gmail.com"); + aboutData.setBugAddress("minh at fedoraproject.org"); aboutData.addAuthor("Minh Ngo", i18n("Architecture. Project Management"), - "nlminhtl at gmail.com", - "http://ignotusp.fedoraproject.org";); + "minh at fedoraproject.org", + "http://fedoraproject.org/~minh/";); aboutData.addCredit("Bohdan Rybak", i18n("Game engine tester"), @@ -59,7 +59,7 @@ int main(int argc, char **argv) QLatin1String("kdots"), VERSION, i18n("A prototype of the game of dots."), KAboutLicense::BSDL, - QLatin1String("Copyright(c) 2011-2012 Minh Ngo")); + QLatin1String("Copyright(c) 2011, 2012, 2014, 2015 Minh Ngo")); initAboutData(aboutData);
