フォルダには README.txtファイルを作って置いておく

アプリケーション（ソフトウェア）が入っているフォルダに、「README.txt」というテキストファイルが入っているのを見たことがあるでしょうか？（拡張子がなかったり、別の拡張子になっていることもあります）

厳密にはアプリケーションに限らないのですが、配布されたフォルダに README.txt が入っていれば、通常は「まずは、このファイルを見て下さい。ここに説明が書いてあります。」という意味になります。これはほとんど慣例のようなものです。アプリケーションであれば、インストール方法が説明されたINSTALL.txtというファイルが置いてあることもあります。

ここからが本題なのですが、この慣習は「自分で作成したフォルダとファイル」でも役に立ちます。

ファイルと言っても、

• 貰ったファイル
• 既存のファイルに自分で編集を加えたファイル
• 自分で作成したファイル

などいろいろありますが、作成したファイル内に、「そのファイル自身についての説明」を書いておけることはあまりありません。また、いくら自分で作成したファイルであっても、何ヶ月もすれば、そのファイルが何だったのかだんだん分からなくなってきます。ですので、そのフォルダ内のファイルについての説明を README.txt という名前のテキストファイルに書いておくと、後から見た時に思い出すことができて大変便利です。

では、どうやって書くのか？についてですが、決まりはありませんのでご自分で分かりやすいように書けばよいと思います。

例えば、以下のように、Markdownという形式を利用して書くことができます。

ファイル名１
-------------

ここに「ファイル名１」についての説明を書きます。


ファイル名２
-------------

ここに「ファイル名２」についての説明を書きます。

リスト形式で書く場合は、以下のように書くことができます。

- １つ目の文章
- ２つ目の文章
- ３つ目の文章

テキストファイルを活用しましょう

2017.06.06

まとめ

「自分でフォルダを作って、そこに何らかのファイルを置く」 という作業を行った場合は、README.txt を作って、そこにあるファイルについての説明を書いておきましょう！

これは、Windows, Mac, Linux を問いません。