【readme】について

Last-modified: 2022-06-27 (月) 11:36:10


readmeとは

ソフトについての取扱説明書となります。
ファイル形式は、windowsならば「メモ帳」などのテキストソフトで作成したテキストファイルの拡張子をつけた「readme.txt」が一般的です。
見栄えを良くしたい・内容が少し多めなどの場合は、html形式で作成した「readme.html」にしてみましょう。
「readme」のファイル名を分りやすくしたい場合は、「取扱説明書」「解説書」「ガイド」「最初にお読みください」「始める前に」などの日本語にしておくのも良いかと思われます。


  • ウィキペディア　＞ リードミー

    リードミー（Readme）とは、ソフトウェアを配布する際の添付文書のひとつ。

    配布物の一般的な情報を記載したファイルである。

    多くの場合、そのソフトウェアをインストールし使用する前に読むべきものとされている。




readmeに記載される内容

記載する内容や順番については、制作者の判断で行ってください。
配布物に関する情報や作者の意向などを細かく記載したり、必要最低限の情報だけの簡易版にしたり様々です。
以下は一般的に記載される内容とその例です。


はじめに

  • 制作者側からの挨拶などです。
    ◆ はじめに《例》
    この度は「Lvスタイル」をダウンロードして頂きまして、誠にありがとうございます。


概要

  • ソフトの概要です。
    【タイトル】
    【ソフト名】    		作品のタイトル。
    《例》Lvスタイル基
    【ジャンル】作品のジャンル。
    《例》推理アドベンチャーゲーム・恋愛シュミレーションゲーム等
    【年齢制限】作品の年齢制限。
    《例》無し・18歳以上推奨等
    【種　別】フリーソフト、シェアウェア等。
    《例》フリーウェア・無料ダウンロード版・有料ソフトウェアの無料体験版等
    【制　作】制作者名・制作サークル名等。
    《例》Soul Engine Project
    【開発環境】使用したゲームエンジンや開発OS環境等。
    《例》Light.vn（http://lightvn.net/）
    【動作環境】推奨動作環境やOS等。
    《例》WindowsXP/7/8/10（ゲームエンジン「Light.vn」の動作環境に準じます）
    【バージョン情報】
    【最終更新日】    		ver0.00
    ○年○月○日
    【プレイ時間】
    【所要時間】    		クリアまでのだいたいのプレイ時間。
    《例》約１時間・３～５分程度等。


インストール / セットアップ / 使用法

  • インストール方法やゲームスタート方法です。
    【起動方法】ゲームスタート時に実行するファイル名。
    《例》フォルダ内の「Light-vn.exe」をダブルクリックすると起動します。
    【実行ファイル】《例》Light-vn.exe


アンインストール

  • アンインストール方法です。
    ◆ アンインストール《例》ゲームフォルダごと、全てのファイルを削除して下さい。


操作方法 / 各種機能

  • ゲーム内での操作方法です。
    ゲームスタート《例》タイトル画面「開始」ボタンにて最初からゲームが始まります。
    セーブ《例》「MENU」ボタンからメニュー画面「SAVE」ボタンにてセーブ画面に移行します。
    ロード《例》「MENU」ボタンからメニュー画面「LOAD」ボタンにてロード画面に移行します。
    途中から始める《例》タイトル画面「続き」ボタンにてロード画面に移行します。
    タイトルに戻る《例》「MENU」ボタンからメニュー画面「タイトルに戻る」ボタンにてタイトル画面に移行します。
    終了《例》タイトル画面「終了」ボタンにて終了します。もしくはウインドウ右上の×ボタンにて終了します。
    操作等の注意事項《例》稀にボタン動作がエラーになることがありますが、その場合はもう一度押してください。
    備考《例》セーブが出来ない人・書き込みが出来ない人への対応～～


免責事項

  • 免責 - 普通なら負うべき責任を問わずに許すこと。
    本ゲームソフトの使用により、不測の事態が起こったときに「責任を負えません」と明記し約束を求めるもの。
    余計なトラブルを避けるためにも記載しておいたほうが良さそうです。
    • 《例》
      この作品をインストールしたことによるいかなる損害も、当サークルは一切責任を負わないものとします。
      ご使用は自己責任でお願いいたします。


著作権等

  • 作品や素材などの著作の所在を明記しておきましょう。
    著作に関する余計なトラブルを避けるためにも記載しておいたほうが良さそうです。
    • 《例》
      この作品の著作権は「Soul Engine Project」にあります。
      本作品を無断で複製・転載・配布・改変・販売等を行う事は禁止します。
      また制作にて使用させて頂いた素材の著作権はそれぞれの制作者様にあります。


使用したツール / プラグイン / 素材等

  • 使用させていただいた素材のサイトの利用規約に基づいて、その旨を明記しましょう。
    • 《例》
      以下のサイトで公開されている素材を使用させていただきました。
      使用させて頂いた素材の著作権はそれぞれの制作者様にあります。
      音楽
      ・サイト　様（http://○○○○/）
      ・サイト　様（http://○○○○/）
      背景
      ・サイト　様（http://○○○○/）
      ・サイト　様（http://○○○○/）
      写真・テクスチャ
      ・サイト　様（http://○○○○/）
      ・サイト　様（http://○○○○/）


連絡先 / お問い合わせ / コンタクト

  • ホームページのアドレスや連絡方法です。
    • 《例》
      公式webサイト：http://○○○○/
      本作品に関するお問い合わせは、下記にお願いします。
      ・メールアドレス：xxx@xxxx.ne.jp


ご注意事項

  • その他もろもろ、言っておきたいこと書いておきたいことなどがある場合は記載しましょう。
    • 《例》ゲーム内の画像使用について（二次創作、使用、紹介について）
    • 《例》実況プレイ動画・生放送について
    • 《例》作品内容の開示、感想・レビュー等（ネタバレについて）


ゲーム詳細

  • システム面や世界観的に必要であるならば詳細を記載しましょう。
    • 本作品「○○」とは？
    • 本作品の物語
    • ゲームシステム解説
    • メニュー解説
    • 主要登場人物の紹介