Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[0.16] downlaoderがダウンロードしたmodels内のREADMEやTERMSをmdからtxtにしたい #971

Closed
Hiroshiba opened this issue Feb 5, 2025 · 3 comments · Fixed by #989

Comments

@Hiroshiba
Copy link
Member

内容

.mdファイルは開発者的にはテキストファイルだと認識できるのですが、開発者ではない人にはあまり一般的ではないはずです。
あと法律的な側面を考えると、ちゃんとユーザーに提示したと言えるように.txtファイルの方が望ましい気がしました。

なので.mdファイルをダウンロードするとき、保存時の拡張子を.txtとしたいです。

Pros 良くなる点

分かりやすい

Cons 悪くなる点

マークダウン形式だとわかる人にとってはフォーマットされないので見づらいかもしれない。
(プレーンテキストでも読めるように作ってるので大丈夫ですが)

実現方法

ダウンローダー側で対処するのが良さそう感。
(元のファイルはGithubで見やすいようにマークダウンの方が良さそう)

その他

(どこかで同じこと書いたかも)

@qryxip
Copy link
Member

qryxip commented Feb 8, 2025

ダウンローダー側で対処するのが良さそう感。

ちょっと思ったのですが、ダウンロードする経路が必ずしもダウンローダーではないことを考えると、一貫性のためにリリースの段階で置き換えてもいいんじゃないかとは思いました。あ、でもvoicevox_vvmは厳しいか…
(ちなみにc-apiは今、リリース時にREADME.mdをREADME.txtにリネームするということをしています。多分どっちかに倒した方がよい)

@Hiroshiba
Copy link
Member Author

voicevox_vvm側、releasesにアップロードするか考えたんですが、とりあえず一旦リポジトリでいいかなと思いました。。
ぶっちゃけどっちでも良さそうな気がするけど決定打がないんですよね。。

あ、.txtをアップロードするかどうかですが、これは入り口がダウンローダー以外にあることはあまり考えなくても良いと思いました!
公式が想定する経路はあとGithubだけなので・・・!

@Hiroshiba
Copy link
Member Author

voicevox_vvm以外のことを考えてませんでした!

Githubのソースコードとして閲覧できるところは.md、そうじゃないところ(releasesに直置きする、releases内のzip内に配置する、ダウンローダーでダウンロードしてきたもの)は.txtが良いかなと思いました!!
「いい感じに見れる人を最大化する」のが目的です。
Githubでソースコードとして閲覧できるものは.mdの方が良く、手元の PC に配置されるものは.txtが良いかなと!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants