Readme: Difference between revisions

From Jedi Knight Wiki | JKHub
(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...")
 
(Outdated info)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
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.
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:
The publisher has demanded that the following must be included in the readme for all mods:


{| class="wikitable"
{| class="wikitable"
Line 8: Line 8:


===Trivia===
===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
* 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

Latest revision as of 21:51, 29 February 2020

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 publisher has demanded that the following must be included in the readme for all mods:

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[edit]

  • 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