Rework of the README file.

Move the kpacman html api's files into the doc folder.
Add a man page.
Rework of the desktop file.

Signed-off-by: gregory guy <gregory-tde@laposte.net>
pull/1/head
gregory guy 2 years ago
parent f9ea8458f5
commit a451e44f4a
No known key found for this signature in database
GPG Key ID: 3BCCA0F7AB4536F4
  1. 2
      README
  2. 0
      doc/kpacman-api/Kpacman.html
  3. 0
      doc/kpacman-api/all-globals.html
  4. 0
      doc/kpacman-api/full-list-Kpacman.html
  5. 0
      doc/kpacman-api/header-list.html
  6. 0
      doc/kpacman-api/hier.html
  7. 0
      doc/kpacman-api/index-long.html
  8. 0
      doc/kpacman-api/index.html
  9. 0
      doc/kpacman-api/kpacman_h.html
  10. 5
      doc/man/CMakeLists.txt
  11. 42
      doc/man/kpacman.1
  12. 6
      kpacman/kpacman.desktop

@ -1,5 +1,5 @@
kpacman - A pacman game for KDE.
kpacman - A pacman clone game for TDE.
Kpacman is a classic arcade game.

@ -0,0 +1,5 @@
INSTALL(
FILES ${PROJECT_NAME}.1
DESTINATION ${MAN_INSTALL_DIR}/man1
COMPONENT doc
)

@ -0,0 +1,42 @@
.TH kpacman 1 "August 20, 2020"
.SH NAME
kpacman \- A pacman clone game for TDE.
.SH SYNOPSIS
.B kpacman
.RI [Qt-options] [TDE-options] [URL]
.SH DESCRIPTION
Kpacman is a classic arcade game from the 80s in which you have
to finish the tables by eating all the pac-gums to score as many points
as possible.
.PP
.SH OPTIONS
.SS
.SS Generic Options:
.TP
.B --help
Show help about options
.TP
.B --help-qt
Show Qt specific options
.TP
.B --help-tde
Show TDE specific options
.TP
.B --help-all
Show all options
.TP
.B --author
Show author information
.TP
.B -v, --version
Show version information
.TP
.B --license
Show license information
.SS
.PP
.SH HOMEPAGE
Homepage: https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman
.SH AUTHOR
This manual page was written by gregory guy <gregory-tde@laposte.net>,
for the Trinity Desktop Environment project (but may be used by others).

@ -4,9 +4,13 @@ Exec=kpacman -caption "%c" %i %m
Icon=kpacman.png
MiniIcon=kpacman.png
X-DocPath=kpacman/index.html
Comment=
Comment=A simple clone of the classic arcade game Pac-Man
Comment[de]=
Terminal=false
Name=Kpacman
Name[de]=Kpacman
Name[fr]=Kpacman
GenericName=Arcade Game
GenericName[fr]=Jeux d'arcade
Categories=Qt;TDE;Game;ArcadeGame;
Keywords=arcade;pacman;dots;ghosts;level;

Loading…
Cancel
Save