
あなたのプロジェクトのための整頓された洗練されたreadmeテンプレート!
スクリーンショット・要件・アーキテクチャ・テクノロジー・ライセンス
read-my-readmeは、 Best-Readme-Templateに基づいて、シンプルな整頓された読み取りテンプレートです。
もともとはモバイルプロジェクトで使用されるように調整されていますが、他の異なるユースケースに適合するように簡単にカスタマイズできます。
まだインスピレーションを感じていますか?特定のカスタマイズを備えたこのREADMEスタイルを使用するサンプルは次のとおりです。
このセクションでは、プロジェクトのUI/UX、テーマ、アニメーションの詳細について説明します。
このセクションのアニメーションとインタラクティブなコンテンツはreadme-assets/gifsの内側に配置する必要があります。
| アニメーション1 | アニメーション2 | アニメーション3 | アニメーション4 |
|---|---|---|---|
![]() | ![]() | ![]() | ![]() |
(トップに戻る)
ここでは、プロジェクトのスクリーンショットを追加し、使用した設計システム(マテリアル /クパチーノ /カスタム)とさまざまなUIモード(夜 /暗い)を参照できます。
このセクションのスクリーンショットはreadme-assets/imagesの内側に配置する必要があります
| 画面1 | 画面2 | 画面3 |
|---|---|---|
![]() | ![]() | ![]() |
![]() | ![]() | ![]() |
| 画面4 | 画面5 | 画面6 |
|---|---|---|
![]() | ![]() | ![]() |
![]() | ![]() | ![]() |
(トップに戻る)
ここでは、プロジェクトをローカルにセットアップする方法(インストール、APIキーなど)を説明できます。
git clone https://github.com/your_username_/Project-Name.git npm installconfig.jsにAPIを入力します
const API_KEY = 'ENTER YOUR API' ;(トップに戻る)
このセクションでは、プロジェクトで使用されているアーキテクチャにコメントする必要があります。
(トップに戻る)
このセクションでは、プロジェクトをブートストラップするために使用される主要なフレームワーク/ライブラリをリストする必要があります。
(トップに戻る)
あなたの名前 - @twitter_usernamme [email protected]
注:多くの貢献者がいる場合は、使用を検討することができます。
(トップに戻る)
MIT License
Copyright (c) 2023 Jonathan Areas
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
(トップに戻る)