タグ

ブックマーク / tech.admax.ninja (1)

  • 【GitHub】GitHubのWikiを書く | AdMax Tech Blog

    AdMaxSDKの使い方はすべてWikiに書いています。 ライブラリなどを作成してGitHubを使って世に公開したときにREADME.mdに使い方すべてを書いてしまうと、とっても読みづらいです。 どんなライブラリか、対応バージョン、インストール方法など簡単に書けるものはREADME.mdに書くで問題ないと思います。 しかし、細かい使い方やAdMaxSDKみたいにあまり使い方がわかっていない人に対して「SDKを用意したから勝手に使ってください。」という姿勢は失礼だと思ったのでWikiにすべてを書きました。 なので、今回はGitHubにWikiを公開するまでの流れを書きます。 リポジトリの作成 なにはともあれリポジトリを作成します。 ここは割愛させて頂きます。 Wikiの作成 ではさっそくWikiを作成します。 リポジトリの画面の右にWikiのリンクがあるのでそれをクリックしてください。 リン

    【GitHub】GitHubのWikiを書く | AdMax Tech Blog
  • 1