SuperTux / supertux

SuperTux source code
https://supertux.org
GNU General Public License v3.0
2.48k stars 474 forks source link

More documentation for tools #337

Open Hume2 opened 8 years ago

Hume2 commented 8 years ago

Actually, the tools we have in tools/ have just a little documentation and not much useful. It should be there described well what purpose does it serve and what's the input and output. There's a summary of what is missing:

There are also some tools in the tools/ directory, not sorted out. I think, it needs to sort them out to separate dirrectories.

maxteufel commented 8 years ago

Agreed; this should be in the wiki once we're done cleaning up the imported files.

  • build-addon-index: Good, but input/output?

This one should be moved to the addons repository.

maxteufel commented 8 years ago
  • darwin: There's a picture, but it's unclear whether there's something missing or it demonstrates the result. There's absolutely no written text in it.

This one is pretty obvious for OS X users (which uses the Darwin kernel) - it's actually a background for the DMG - It's supposed to tell the user to move the SuperTux.app to the Applications folder.

Karkus476 commented 8 years ago

@maxteufel Why not include it in the doc directory too, for offline reference?

maxteufel commented 8 years ago

@maxteufel Why not include it in the doc directory too, for offline reference?

@Karkus476: Might be a good idea for specific documentation on core features, however, we can't put a copy of the entire wiki in there and keep it up to date.