GitHub Readme.mdの書き方

 Japan GitHub Ranking | 🗻日本語しか読みたくない人のためのGitHubランキング Ranking of repositories in Japanese (zzzmisa.com)

に有名な日本語GitHubレポジトリ集が載っています。

後で、サンプルレポジトリを書きますが、日本語プロジェクトでは、日本語でreadme.mdを書いて頂きたいと思います。いわば、取り扱い説明書になります。

このmdという拡張子はマークダウンという奴です。スケジュールナースのサイトは、hugoというサイトジェネレータを使っていますが、このとき書くのは、xxx.mdで、テキストエディタで書いています。それをhugoで、htmlに変換する訳です。

ただし、テンプレートを販売している業者やOpenSourceが沢山あるので、自分のサイトイメージに近いものを選んで自社用サイトに作り替えていく訳です。OpenSourceの方は、無料なのですが、品質だったり、痒いところに手が届かなかったりで、結局は業者の販売するものを買ったのに落ち着きます。この辺は、Wordpressと同じ状況かもしれませんが、テンプレートは一回切りなので割り切れます。

とりあえずは、Readme.mdがどんなものであるか？概観して雰囲気を掴むことはできると思います。

スケジュールナースのプロジェクトは、日本語と英語があります。例えば、ベンチマークを走らせるには、プロジェクトは全て英語なので、英語モードにOSを変更しないと読めません。また、RepositoryViewerも言語に応じて、レポジトリ部分を選んでいるので、Japanese/Englishといったディレクトリ構成にする必要があります。（将来対応言語を増やすかもしれません。）

＜スケジュールナースプロジェクトでビジネス＞

スケジュールナースプロジェクトをGithubで公開して、商売をするのは自由です。プロジェクトファイルの著作権は、作成者にあります。ExcelBookやシートを有料で販売している業者があるように、プロジェクトを有料で販売するのは自由です。Excelシート中にVBAを含むのは、プロジェクトファイル中にPythonコードを含む場合があるのに似ています。しかしながら、Excelというアプリケーションがインストールされていないと、Excelファイルがあっても使えないのは、プロジェクトファイルがあっても、スケジュールナースがないと使えないのと同じです。

例えば、「フレームワーク的なもののみをGithubで公開、細かな実装は、受託設計・メンテナンスします、」でもOKです。実際、そのビジネススタイルは、Hugoで既にあるものですが、各国、法律・仕様が異なるので、各国・各業種毎に、そういう業者が必要になる点が異なります。全部英語で済む、というものではありません。