m-masaki72 / SANA_8BIT_VST

GNU General Public License v3.0
123 stars 8 forks source link

ZIPファイルに同梱するREADMEをより一般ユーザー向けの形式に #22

Closed Phroneris closed 3 years ago

Phroneris commented 5 years ago

ReleaseからダウンロードできるZIPファイルにはREADME.mdが同梱されていますが、一般的なDTMerは.mdファイルを開けません。 同梱版はテキスト形式で保存するか、画像やリンク等のMarkdown記法を活かすならPDFやHTMLに書き出すか、あるいはいっそGitHub上のREADMEへのリンクしか同梱しないようにしてしまうか、何にせよ一般ユーザーが普通に開くことのできる形式にするのがふさわしいかと思います。

まぁ仮に開いても、ビルド方法などは一般ユーザーにはあまり関係のないところですが…。 そう考えると、内容についてもZIP同梱版には一般ユーザー向けのものを別途用意する方が良いかもしれません。

参考までに、私はリンクだけ示すパターンで、GitHub上のWikiに丸投げするのをよくやります。

あるいはGitHub上のREADMEを詳記する場合、配布ZIPファイルにはそのREADMEではなく必要な情報だけをまとめた別のテキストファイルを同梱することもあります。

Phroneris commented 3 years ago

c4c895a7595cfcb6ce7fa33dcd9f767896ed0ce1 で修正されたようなので、Closeします。

Phroneris commented 3 years ago

余談ですが、コミットやPRのメッセージを書く際に "fix" 等の特定のキーワードをIssue番号と組み合わせて使うと、GitHub上のIssueを自動Closeできるらしいです。 例えばこちらのコミット→ https://github.com/tootsuite/mastodon/commit/be507cd82e8997fd391d13aa495290d93a1944d4(他人様のですが)では、1行目に何をしたかを書き、2行目をGitのしきたりで空行にして、3行目に Fix #11478 と書いて自動Closeを発動させているようです。

参考になれば幸いです。