Android向けライブラリ用README

Android向けライブラリ用README

READMEの必要性

せっかくライブラリを作るなら使ってもらわないと損。
というわけで、一見してこのライブラリが何ができるか？使い方は？がわかるREADMEにするために試行錯誤したのでその内容を書き留めておく。

いかんせん調べながら書いてみている程度なので、改善できるポイントなどあればご意見を賜りたい。

記載する内容

まず参考にさせていただいたのはこちら。わかりやすいREADME.mdを書く | SOTA

全てがすぐに用意できるわけではないので、参考にすぐ書けそうなものだけ挙げてみる。
GIF は、ライブラリが形になったらぜひ動作イメージなど載せてみたいと思う。 VS. も、まだあまり類似調査などしていないが重要なことなので、調べたら随時追記していこうかな。

例

と、いうわけで今回書いてみた README が下記。

LibImplementSample/README.md at master · kfurue/LibImplementSample

Usage について少し追記。

repositories {
    ・
    ・
    ・
    maven { url 'http://raw.githubusercontent.com/kfurue/LibImplementSample/master/repository/'}
}
  ・
  ・
  ・
dependencies {
    ・
    ・
    ・
    compile 'com.example.librarytest:librarytest:1.0.0'
}

上記を app の build.gradle に書いてくれれば使えるようになりますよ、という内容。
repositories に記載する url は、LibImplementSample/repository at master · kfurue/LibImplementSample のパスのドメイン名部分(github.com)を raw.githubusercontent.com に変更し、https -> http にしたもの。

dependencies に記載する内容については、LibImplementSample/librarytest-1.0.0.pom at master · kfurue/LibImplementSample に記載した内容が肝となる。

[groupId]:[artifactId]:[version]

を記載する。

上記を実際にテスト用アプリの app/build.gradle に記載し、今回のサンプルライブラリが使用可能になることは確認済み(Android Studio 2.0 でも成功)。

今後

CHANGELOG, LICENSE, CONTRIBUTING.md など、リポジトリ内に配置する定型のようなものもありそうな雰囲気。
この辺りまで含めて、リポジトリの雛形とも言えるものについてまとめてみたい。(調べてみたらまとまっているものがあるかもしれない)