Readme

From Jedi Knight Wiki | JKHub
Revision as of 02:59, 22 February 2013 by Reagan (talk | contribs) (Created page with "A '''readme''' is a text file that documents the mod. The modder usually includes the following information in a readme: Title, author, date completed, file name, inst...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

A readme is a text file that documents the mod. The modder usually includes the following information in a readme: Title, author, date completed, file name, installation instructions, contact, bugs, description, credits, permissions (regarding usage in other work), and legal information.

The following information must be included on all mods for legal reasons:

THIS FILE OR THIS LEVEL IS NOT MADE, DISTRIBUTED,OR SUPPORTED BY LUCASARTS, A DIVISION OF LUCASFILM ENTERTAINMENT COMPANY LTD. ELEMENTS TM & (C) LUCASARTS, A DIVISION OF LUCASFILM ENTERTAINMENT COMPANY LTD.

Trivia

  • JKHub does not require readmes to be included with the mod because the legal information is built into the description page
  • It is common practice to include the readme of another author's content if you are using it in your mod, after personal permission has been obtained
Retrieved from "https://jkhub.org/wiki/index.php?title=Readme&oldid=517"