Peta dunia

 

EN

Dunia 5: Kerja Berpasukan

Tulis README yang hebat

Anda akan belajar: apa yang README hebat beritahu, dan ikut urutan apa.

Teks BM belum disemak oleh penutur asli.

Masalahnya

Repo latihan — bukan laman web sebenar
sam-builds / quiz-game
main
README.md

kuiz

benda-benda

Permainan kuiz Sam mungkin seronok. Tapi README dia cuma tulis “benda-benda”. Apa benda ini? Macam mana nak main? Ramai pelawat terus pergi.

Cuba

README: Fail pintu depan sesebuah repo. Ia terangkan projek itu dan cara mula. yang hebat jawab lima soalan. Susun soalan itu ikut urutan yang baik.

Soalan pertama di atas. Susun ikut turutan. Guna anak panah, atau seret.

  • Projek ini buat apa?
  • Kenapa ia berguna?
  • Siapa yang jaga projek ini?
  • Macam mana nak mula?
  • Di mana nak dapat bantuan?

Cuba

Baiki README Sam. Tambah satu baris tentang fungsi permainan itu. Kemudian tambah bahagian Mula di sini, dengan satu arahan dalam backtick.

Tambah penerangan pendek, tajuk ## Mula di sini dan satu arahan dalam backtick.

Pratonton

Permainan Kuiz

0 daripada 3 matlamat siap

Teka

Baris pertama mana yang paling bantu orang asing?

Semak

Tabiat README yang bagus, atau perlu baiki? Leret setiap satu.

Leret ke kanan untuk bagus, ke kiri untuk perlu baiki. Atau guna butang.

1 / 4

Tunjuk arahan pasang dalam blok kod

Cuba

Misi sebenar, kalau anda mahu: beri repo diari anda di GitHub README yang hebat. Kemudian semak di sini.

Semak di GitHub

Nama pengguna anda dihantar ke api.github.com sahaja.

  • Repo diari anda ada README.mdBelum disemak

Anda berjaya!

Kini anda boleh tulis README yang mengalu-alukan orang asing.

Nak tahu lebih (pilihan)

GitHub tunjuk README dari .github/, folder atas atau docs/. Ia semak ikut urutan itu. Tambah gambar dengan teks alt, supaya semua orang tahu isinya. Guna pautan relatif macam [Bantu](CONTRIBUTING.md): ia berfungsi dalam setiap salinan repo. README profil datang dalam Dunia 12.