書式設定を心配することなく書いてください。フォーマットしてください。あなたが書いているように書式を設定すると、あなた自身の思考の列を中断するときに、よりスティルテッドなテキストが作成される可能性があります。しかし、書式を設定しても、ユーザーは不愉快になります。
READMEは、ユーザーがあなたのソフトウェアを入手した最初の印象であることを忘れないでください。そして、あなたは彼らが第一印象について何を言っているのか知っています。本当にひどく表示されるREADMEによって私は非常に不満を感じるか、私をスクロールさせます。
特に、Windowsベースのプロジェクトのドキュメントを作成している場合は、READMEをメモ帳で開くことをお勧めします。これは、多くのユーザーがテキストファイルを開くための既定値となるためです。
(マルチプラットフォームプロジェクトにはどのような行末を使うべきかという問題があります。プロジェクトにはREADME.windowsとREADME.linuxなどがありますが、これはうまくいくものの、多くの労力が必要です
最後に、プロジェクトが普及している場合は、READMEを読むよりも多くの時間を費やすことに注意してください。後でフォーマットするのに5分かかりますが、500人の読者がいる場合は、ユーザーあたり2分の1未満の時間を費やしてしまい、潜在的に大きなメリットがあります。私はあなたが(Eclipseの、どこにでもコマンドラインでTextMateの、13" ラップトップを使用してワイドスクリーンモニタ)私は、同時に多数の異なる環境で働く固定幅のreadmeのため:)
奇妙なことに、正解はあまり主観的ではないようです。 – ojblass