lib-installation-examples

状況

• 未着手
• いつ着手する？
  • 気が向いたら
    • 機が熟したら

いろいろ

• イメージ
  • このリポジトリをcloneするだけで、最低限のことができる
    • 最小のものを用意しておく
      • 作者のメンテが楽な範囲で実施する
    • 余力枠
      • ちょい規模のあるもの、など段階的に用意するのも、よさげ
• メリット
  • 作者の学びになる
    • 「こういうのが欲しかったのに」と思ったこともある
  • 利用したい人が楽になる
• これまでの課題
  • ライブラリを作った
    • どうやって利用するか、のREADMEも書いてある
    • でも実際に利用できているか？の検証に漏れがあることが多い
    • 作者自身も、他の人のリポジトリ利用するとき、わからなくて止めることが多い
    • ライブラリのリポジトリそのものにexampleを入れるスタイルもあるが、
      • それが向かないライブラリもある
  • 対策案
    • examplesをリポジトリとして用意して、
    • 試してみよう
• 具体的なイメージ
  • 対象
    • npmやCDN、cargo等、パッケージマネージャ等でGitHubやCDNを指定してinstallするもの
    • 注意
      • 「cloneすれば使える」タイプは、このexamplesのREADMEに書いて、userが消去法でわかるようにする
        • このリポジトリに入れる必要がありません、
          • 本体をcloneすれば使えるので使ってください、とする
      • 既に技術スタックとして組み合わせが実現しているものは、採用可否の根拠を示す
        • 例、mml to smf は、様々なアプリから利用されるライブラリ、の位置付けが想定されるので、
          • なので採用
          • 実際、play-mmlからも、mml-editorからも、tone-editorからも、利用されるはず
            • ※tone-editorからの利用は今後だったかも
  • 最小限
    • そもそも動かない、環境構築、の疎通確認用
    • hello worldに類似
    • なので実用性が皆無で、1つだけ確認ができる、くらいでいい
  • 余力枠
    • ちょい規模がある版
      • 「こんなに削ったらほとんど意味がないのでは」というくらい最小限は削るので、
      • 意味がある程度に規模を大きくした版
      • メンテコストが高いため、あくまで余力枠
  • dir構成の例
    • リポジトリname/ が複数
      • 配下に、
        • web版 最小限
        • web版 ちょい規模がある ※余力枠
        • ネイティブ版 最小限
        • ネイティブ版 ちょい規模がある ※余力枠
  • 対象リポジトリ例
    • mml to smf
      • ネイティブ版
        • 最小限のライブラリの利用のrust projectのdirにする
      • ブラウザ版
        • 今後本体に実装予定