Latihan Membuat Readme untuk Repository


Tujuan
Latihan Membuat Readme untuk Repository ini bertujuan untuk mengajarkan Anda bagaimana cara membuat berkas readme dalam repository. Beberapa bagian dari latihan ini akan menjawab berbagai pertanyaan, seperti:

Apa itu berkas readme dalam sebuah repository?
Bagaimana cara membuat berkas readme?
Apa yang perlu diperhatikan dan dipersiapkan?


Tahapan Proses
Berikut tahapan proses yang akan kita lakukan dalam latihan membuat readme baru dalam repository:

Membuka halaman repository yang dibuat pada latihan sebelumnya.
Membuat berkas readme baru.
Menambahkan teks ke dalam berkas readme.
Menyimpan berkas readme.
Melihat hasil penambahan berkas readme.




Latihan Membuat Readme untuk Repository
Hampir semua pengguna Git pasti membuat README pada repository mereka, yakni berkas teks yang berisi informasi tentang penjelasan singkat/detail, cara penggunaan, dan sebagainya pada projek yang ada di dalam repository tersebut.

Berkas readme biasanya akan dilihat pertama kali sewaktu mengunjungi repository Anda. Berkas README biasanya berekstensi markdown (.md) yang digunakan untuk menghasilkan sebuah html ringkasan. Maksudnya seperti apa? Jika kita mengeksplorasi repository yang ada di GitHub, perhatikan pada bagian bawah repository tersebut, pasti terdapat tampilan dari berkas README.md. Untuk lebih jelasnya, coba perhatikan bagian gambar yang ditandai berikut.

20210710221948ed7110e2544fe832085f217f563a750f.jpeg

Pada gambar di atas, bisa dilihat bahwa pada bagian bawah repository terdapat tampilan README.md yang menginformasikan berbagai hal mengenai repository tersebut. Ketika membuat README.md di dalam repository, berkas tersebut akan terbaca oleh sistem dan akan ditampilkan hasilnya.

Dalam membuat README.md, ada beberapa hal yang perlu diperhatikan, yaitu struktur README.md. Kalau kita perhatikan pada gambar di atas, ada bagian README yang tersusun dari Heading, Subheading, Paragraf, dan ada beberapa kata yang bercetak tebal ataupun miring.

Lalu, bagaimana cara membuat README.md yang baik? Untuk itu, ikutilah beberapa tahap berikut untuk mengikuti latihan membuat berkas readme untuk repository:

Bukalah kembali repository yang telah Anda buat sebelumnya yang bernama “Daftar-Biodata-Siswa”.
202107051350449336617a552d00d8ebc6312d988ccf05.png

Kemudian, klik tautan README untuk membuat berkas README seperti gambar berikut.
202107051351179a39410492cbc1f6bcdfba3fcfcafe3d.png

Setelah menekan tautan untuk membuat README, kita akan menuju ke halaman pembuatan berkas README seperti gambar berikut:
20210706113130c01826b0a593397d2ea7d854f0a38881.jpeg
Penulisan di README.md itu cukup unik, di mana untuk membuat tulisan heading kita perlu menggunakan simbol (#), lalu diikuti dengan kalimat yang akan menjadi heading.
202107051355389f80a14721081ca8ce7b558aace4be11.png

Anda juga bisa menulis menggunakan simbol (==) pada baris baru setelah kalimat yang ingin Anda ubah menjadi heading. Contohnya seperti gambar berikut:
20210705135616771df6b11aa88fd5ba6e9808a52d7cb1.png

Untuk membuat sub-heading, Anda dapat menggunakan simbol (--) pada baris baru setelah kalimat yang ingin diubah menjadi sub-heading. Berikut contoh penggunaan sub-heading pada sebuah kalimat:
20210705135748db8a16d7f7187abeb5fefd1fe50b5213.png

Anda dapat mengapit kalimat menggunakan simbol bintang (*) untuk membuat tulisan bercetak miring. Berikut contohnya:
20210705135911ebe50a8f4524e8ed3946ccd1aab1309f.png

Jika ingin membuat list, Anda dapat menggunakan simbol (-) dan diikuti dengan kata yang dijadikan item dari list tersebut. Seperti inilah contohnya:
202107051359584bd9a7b01c181f2e3e06c75d99b0726a.png
Tentunya masih banyak cara dalam memberikan format penulisan pada berkas README.md. Untuk latihan membuat README.md ini, kita cukup menggunakan format heading, subheading, list, serta penulisan bercetak miring saja. Untuk format penulisan yang lebih lengkap, Anda dapat mempelajarinya di markdownguide.org/basic-syntax.

Jika Anda kesulitan untuk mengikuti apa yang ditulis dalam berkas readme, silakan gunakan teks berikut ya.
Daftar-Biodata-Siswa
==
Daftar biodata Siswa Dicoding Academy
--
*biodata siswa terdiri dari 3 angkatan yaitu sebagai berikut*
- Angkatan 2019
- Angkatan 2020
- Angkatan 2021

Setelah selesai, periksalah terlebih dahulu tampilan dari apa yang telah kita tulis. Anda bisa menggunakan fitur preview.
2021070514025112fefd7a78b97eca88eab0a14b9d8ff5.png

Jika sudah sesuai dengan ekspektasi, mari kita lanjut ke bagian selanjutnya. SIlakan gulir ke bagian bawah. Anda dapat mengisi kotak pesan commit beserta deskripsi perubahan yang telah Anda lakukan. Jika Anda sudah yakin dengan apa yang telah ditulis, tekanlah tombol Commit new file untuk menyimpan hasil pembuatan berkas README.md tersebut. Seperti inilah hasilnya:
20210705140835940a53cf143f599a8deb1e1a22d302ff.png

Setelah menekan tombol Commit new file, Anda akan diarahkan kembali ke halaman utama repository. Setelah itu, perhatikanlah perbedaan apa yang terjadi pada halaman utama repository. Benar! Berkas README yang telah kita buat akan tampil di bagian bawah dari repository, serta berkas tersebut tersimpan di dalam repository.
2021070514091497a288b49c104772cf858942c70f64b4.png
Keren, kan? Itulah mengapa berkas README cukup penting dalam repository. Sebab berkas readme dapat digunakan sebagai pengantar dan penjelasan dari proyek yang ada dalam repository kita.

Sejauh ini, kita sudah memahami pentingnya berkas README dan belajar bagaimana membuat berkas tersebut dalam repository. Latihan selanjutnya akan mengajarkan Anda bagaimana menambahkan berkas baru ke dalam repository. Oleh karena itu, mari kita lanjut ke materi berikutnya. Tetap semangat ya!