Read My README

Baca-my-readme

Template readme yang rapi dan halus untuk proyek Anda!
Tangkapan layar · Persyaratan · Arsitektur · Teknologi · Lisensi

Read-my-readme adalah template readme yang rapi sederhana berdasarkan pada template readme terbaik .

Awalnya dirancang untuk digunakan dalam proyek seluler, tetapi dapat dengan mudah disesuaikan agar sesuai dengan kasus penggunaan lain yang berbeda.

Masih merasa tidak terinspirasi? Berikut adalah beberapa sampel yang menggunakan gaya readme ini dengan kustomisasi tertentu:

• XPENSOR : Pelacak Pengeluaran Android Lokal
• LaunchPad : Aplikasi tentang Acara Luar Angkasa
• Kiper : Aplikasi Qatar 2022

? ️ ui/ux? ️

Bagian ini adalah tentang merinci UI/UX proyek Anda, tema dan animasi mereka.

Animasi dan konten interaktif dari bagian ini harus ditempatkan di dalam readme-assets/gifs .

Animasi 1	Animasi 2	Animasi 3	Animasi 4

(kembali ke atas)

? Tangkapan layar?

Di sini Anda dapat menambahkan tangkapan layar proyek Anda, referensi sistem desain yang digunakan (materi / cupertino / custom) dan berbagai mode UI (malam / gelap).

Tangkapan layar dari bagian ini harus ditempatkan di dalam readme-assets/images

Layar 1	Layar 2	Layar 3

Layar 4	Layar 5	Layar 6

(kembali ke atas)

Persyaratan

Di sini Anda dapat memberikan instruksi tentang cara mengatur proyek Anda secara lokal: instalasi, kunci API, dll.

1. Dapatkan kunci API gratis di https://example.com
2. Kloning repo

git clone https://github.com/your_username_/Project-Name.git 

3. Instal Paket NPM

npm install

Masukkan API Anda di config.js

 const API_KEY = 'ENTER YOUR API' ;

(kembali ke atas)

? Arsitektur?

Bagian ini harus berkomentar arsitektur yang digunakan dalam proyek.

(kembali ke atas)

? Teknologi?

Bagian ini harus mencantumkan kerangka kerja/perpustakaan utama yang digunakan untuk bootstrap proyek Anda.

(kembali ke atas)

? Penulis?

Nama Anda - @twitter_usernamme - [email protected]

Catatan: Jika ada banyak kontributor, Anda dapat mempertimbangkan untuk menggunakan:

• Daftar Kontributor
• contrib.rocks

(kembali ke atas)

Lisensi

 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.

(kembali ke atas)