2009-06-02 3 views
4

多くの人が両方の方法を論じると確信していますが、残念ながら「公式の答え」はないようです。私のちょっとしたことは書いてみたいと思っていますが、これはあまり重要ではないことに注意を払っていませんが、SOコミュニティが他の選択肢についてどのように感じているのでしょうか?意見がある場合はそれを述べ、支持理由を述べてください。私は、ヴィムがここに私を助けるために埋もれている設定を持っていることを確かめているので、私は両方の世界のベストを持つことができます。README 80文字制限ですか、それともユーザーのエディタで処理できますか?

私の目は、私の目が出血するまで段落を入力し、テキストの途中で各とテキストの書式を設定する必要がないため、折り返しが行われるようにします。

+0

奇妙なことに、正解はあまり主観的ではないようです。 – ojblass

答えて

4

投票

を気に表示します他のほとんどのマウスは存在しないので、ラインを横列にする手段は存在しないかもしれません。

私はより厳しい行の長さを好むようになりました。コードでは、私はそれを管理する手段がないと、100桁以上の長さの行が何かを読む能力を絶対に破壊すると感じています。あなたの読者が何を使用するのかを確かめることはできませんが、もっと短く読みやすい行の長さにするのが最善でしょう。

+0

エディターが長めの長さを読んだら、あなたがカバーしているかどうか、カバーできないかどうかは分かります。非常に単純なポストプロセスと80文字の制限を使用します。ありがとうございました。 – ojblass

+2

+1:特定のドキュメントでテキストエディタをワードラップモードに切り替える必要がありません。それは難しいことではなく、ちょうど迷惑です。 –

2

書式設定を心配することなく書いてください。フォーマットしてください。あなたが書いているように書式を設定すると、あなた自身の思考の列を中断するときに、よりスティルテッドなテキストが作成される可能性があります。しかし、書式を設定しても、ユーザーは不愉快になります。

READMEは、ユーザーがあなたのソフトウェアを入手した最初の印象であることを忘れないでください。そして、あなたは彼らが第一印象について何を言っているのか知っています。本当にひどく表示されるREADMEによって私は非常に不満を感じるか、私をスクロールさせます。

特に、Windowsベースのプロジェクトのドキュメントを作成している場合は、READMEをメモ帳で開くことをお勧めします。これは、多くのユーザーがテキストファイルを開くための既定値となるためです。

(マルチプラットフォームプロジェクトにはどのような行末を使うべきかという問題があります。プロジェクトにはREADME.windowsとREADME.linuxなどがありますが、これはうまくいくものの、多くの労力が必要です

最後に、プロジェクトが普及している場合は、READMEを読むよりも多くの時間を費やすことに注意してください。後でフォーマットするのに5分かかりますが、500人の読者がいる場合は、ユーザーあたり2分の1未満の時間を費やしてしまい、潜在的に大きなメリットがあります。私はあなたが(Eclipseの、どこにでもコマンドラインでTextMateの、13" ラップトップを使用してワイドスクリーンモニタ)私は、同時に多数の異なる環境で働く固定幅のreadmeのため:)

+0

すべての素晴らしい点。しかし、実際にフォーマットを行っても、最終フォーマットは自然にラップされるか、自然にラップされません。私は1つを選ぶ必要があります。 – ojblass

+1

「自然にラップする」または「自然にラップしない」とはどういう意味ですか? 「自然にラップする」というのは、「クライアントのエディタでラップしても、1行に全段落を置く」ということです。明示的に80文字以内にフォーマットしてください。 –

+0

エッジを研磨してファーストクラスにするのはとても難しいです。実際にケアをしているので、あなたの体のすべての繊維があなたにケアを見せたいと思っています。あなたの答えに考えのための優れた食糧をありがとうございます。 – ojblass

2

あなたのアバターによれば、あなたはVimを使用しているので、私はVimのformatoptions = + wがあなたの友人であることを提案します。それは "流されたテキスト"を使用して、再フォーマットするときに多くの問題を保存します。ラップされた行は空白で終わります。これにより、不要な行の再フォーマットを避けることができます。保存するときは、「gggqG」と入力してファイル全体を再フォーマットします。私は長年にわたってformatoptions = tcqwを使ってきました。私はそれに完全に満足しています。

+0

私のアバターはそれを許しましたか?:)私はこのオプションを一度も使用したことはありませんが、私は近いうちにそれを見ています...ヴィムは私を驚かせてくれます。 – ojblass

+0

そのチップをありがとう!うまく動作し、常にVimでそれを行う方法が不思議でした! gqコマンドのドキュメントへのリンクです(ggはカーソルを一番上に、Gはそこから文書の最後まで適用します)。 http://www.vim.org/htmldoc/change.html#gq フォーマットオプション:注意点としては http://www.vim.org/htmldoc/change.html#fo-table 私はreadmeのsrcバージョンを管理する良い方法が何であるか不思議に思っています。それは簡単な更新のための幅の書式設定を持っていません... – Jason

0

80文字以上で、80文字の端末しかないときに読むと馬鹿だ。

これは過去のメッセージのように聞こえるかもしれませんが、いつ本当にはドキュメントを読む必要がありますか?すべてがうんざりしていると、ウィンドウシステムを起動して実行することができません。

人が倒れたときに蹴らないでください.80文字をハード制限として使用してください。

がより広くなる必要はありません。制限です。広すぎない列を読む方が簡単です。新聞には新聞全体に亘る行が書かれていない(読めない)という理由がある。その代わりに、ユーザーの視聴者を自動ラップすることを信頼することです。実際に私は痛みであることが判明しました.Linuxでは(grep、emacs、vim)、Windowsのメモ帳(自動ラップを有効にするためにはメニューを通らなければなりません)などがあります。

これらの理由から、私は80文字以下としてください。

1

テキストのみのreadmeを提供しています。これは、あらゆる種類のPC構成で簡単に読み取ることができます。また、開いたり読んだりする際にさまざまな困難を想像することもできます。また、実際に何かを読んでみたいユーザーのために、という形式のPDFを提供してください。

+0

申し訳ありません... .txtからpdfに変換するための超簡単なトリックですか?私はウェブ上にたくさんあり、私は怠惰であると知っています。 – ojblass

+0

@ojblass:別の質問をするか、それを検索すると、おそらく以前に尋ねられています:) –

関連する問題