Satu paragraf proyek dideskripsikan di sini
instruksi ini akan membuat Anda menyalinin proyek dan berjalan di komputer atau laptop(lokal) Anda untuk tujuan development dan pengujian. Lihat penerapan untuk catatan tentang cara menggunakan proyek pada sistem langsung.
Di bagian atas file harus ada perkenalan singkat dan / atau ikhtisar yang menjelaskan ** apa ** proyek itu. Deskripsi ini harus cocok dengan deskripsi yang ditambahkan untuk manajer paket (Gemspec, package.json, dll.)
Penjelasan singkat tentang motivasi di balik penciptaan dan pemeliharaan proyek. Ini harus menjelaskan ** mengapa ** proyek itu ada.
Hal apa yang Anda perlukan untuk menginstal perangkat lunak dan cara menginstalnya
Berikan contoh
Serangkaian contoh langkah demi langkah yang memberi tahu Anda harus menjalankan pengembangan env
Katakan Langkah apa yang ingin dilakukan
Berikan Contoh
dan ulangi
sampai selesai
Akhiri dengan contoh untuk mengeluarkan data dari sistem atau menggunakannya untuk demo kecil
Jelaskan cara menjalankan tes otomatis untuk sistem ini
Jelaskan apa tes tes ini dan mengapa
Berikan Contoh
Jelaskan apa tes tes ini dan mengapa
Berikan Contoh
Tambahkan catatan tambahan tentang cara menggunakan ini pada sistem live
- Dropwizard - Web Framework yang digunakan
- Maven - Manajemen Ketergantungan
- ROME - Menggunakan generate RSS Feeds
Bergantung pada ukuran proyek, jika kecil dan cukup sederhana, dokumen referensi dapat ditambahkan ke README. Untuk proyek berukuran sedang hingga besar, penting untuk setidaknya menyediakan tautan ke tempat dokumen rujukan API.
jelaskan dan tunjukkan bagaimana cara menjalankan test dengan contoh kode.
Biarkan orang tahu bagaimana mereka bisa terjun ke dalam proyek, sertakan tautan penting ke hal-hal seperti pelacak masalah, irc, akun twitter jika berlaku.
Silahkan baca CONTRIBUTING.md untuk detail tentang kode etik kami, dan proses untuk mengirimkan pull request kepada kami.
Kami Menggunakan SemVer untuk versiVersi. Untuk versi yang tersedia, lihattags on this repository.
- Billie Thompson - Initial work - PurpleBooth
Lihat juga daftar contributorsyang berpartisipasi dalam proyek ini.
Proyek ini dilisensikan di bawah Lisensi MIT - lihat file [LICENSE.md] (LICENSE.md) untuk detailnya
- Kiat tip kepada siapa pun yang menggunakan kode
- Inspirasi
- dan lain lain