## readme.mdサンプルgithubプロジェクトreadme.mdテンプレートreadmeは説明ファイルとして使用されます。目的は、視聴者がプロジェクトを迅速に理解し、鳥瞰図を視聴できるようにすることです。これを行うには、ReadMeを書くときは階層と形式に注意を払う必要があります。Markdownで書くのが最善です。一般的に、少なくとも3つの部分が含まれています。 1つ目は、プロジェクトの背景と使用を導入することです。2つ目は、メソッド(インポート/インストール、露出した呼び出しインターフェイスなどを含む)を使用することであり、3つ目はプロトコルに準拠することです。 PS(初心者はそのようなハイエンド=。=。=。=。=。)を書く必要はないようです)。これは、GitHubに配置されているこのテンプレートを参照できます。
担当者:Lixinyi、LXY、WXM、LHZ、SH ## Githubアドレスhttps://github.com/tanelmer/hisuncle ## Demoアドレスhttp://webcafe.pub/ife/stage1/ ## githubプロジェクトreadme.mdテンプレート
#### 例:
プロジェクトが使用される場合は次のとおりです。 APKダウンロードリンクを配置するか、単にいくつかのスクリーンショットを配置できます。
(この例は最初からリリースされているため、視聴者は、彼が探しているものを探しているかどうかを一目で伝えることができます)
###機能(オプション)
機能a
機能b
###原則の説明(オプション)プロジェクトがどのようなアイデアが設計されているかを説明します
Gradle:
compile 'xxx'(プロジェクト構成方法を説明し、AndroidオープンソースライブラリはGradleでインポートされます)
###それの使用方法、ステップは何ですか、どのインターフェイスがありますか。
たとえば、難読化方法など。
### TODO(オプション)次の開発/メンテナンス計画。
契約を遵守しました
ファイルを無視します