คัดลอกแม่แบบ Markdown README นี้
นี่คือแม่แบบเริ่มต้นที่เขียนไว้ ไม่ใช่ตัวอย่างซอฟต์แวร์ที่ทำงานได้ แทนข้อความในวงเล็บเหลี่ยม ตรวจสอบว่าไฟล์ที่อ้างถึงมีอยู่ และลบส่วนที่ไม่เกี่ยวข้อง บรรทัดติดตั้งและรันด้านล่างเป็นความคิดเห็น เพื่อป้องกันการเรียกใช้คำสั่งตัวแทนโดยไม่ตั้งใจ
# [ชื่อโครงการ]
[หนึ่งประโยค: ปัญหา ผู้ใช้เป้าหมาย และผลลัพธ์]
## ตัวอย่าง
[แสดงข้อมูลเข้าขนาดเล็กและผลลัพธ์ที่คาดหวัง หรือเพิ่มภาพหน้าจอ]
## เริ่มต้นอย่างรวดเร็ว
ข้อกำหนด: [สภาพแวดล้อมรัน/เวอร์ชัน และบริการที่จำเป็น]
```sh
# แทนด้วยคำสั่งติดตั้งที่ตรวจสอบแล้ว
# แทนด้วยคำสั่งที่สั้นที่สุดซึ่งให้ผลลัพธ์ที่มีประโยชน์
```
ผลลัพธ์ที่คาดหวัง: [สิ่งที่ผู้อ่านควรเห็น]
## การตั้งค่า
[การตั้งค่าที่จำเป็น ค่าตัวอย่างที่ปลอดภัย และตำแหน่งจัดเก็บข้อมูลลับ]
## เมื่อใดควรใช้
- [กรณีใช้งานที่ชัดเจน]
- [กรณีใช้งานที่สอง]
## ข้อจำกัด
[ข้อมูลเข้าที่ไม่รองรับ ระดับความพร้อม ข้อจำกัดด้านประสิทธิภาพหรือแพลตฟอร์ม]
## เอกสารและความช่วยเหลือ
[ลิงก์เอกสารและคำอธิบายว่าจะถามคำถามได้ที่ไหน]
## การร่วมพัฒนา
ดู [CONTRIBUTING.md](CONTRIBUTING.md)
แจ้งปัญหาที่ทำซ้ำได้ผ่านแท็บ Issues ของที่เก็บโค้ด
## สัญญาอนุญาต
ดู [LICENSE](LICENSE)ปรับตัวอย่างให้เหมาะกับประเภทที่เก็บโค้ด
สำหรับเครื่องมือบรรทัดคำสั่ง ให้แสดงไฟล์ข้อมูลเข้า คำสั่ง และผลลัพธ์สั้น ๆ สำหรับไลบรารี ให้แสดงตัวอย่างนำเข้าและเรียกใช้ที่เล็กที่สุดแต่ครบถ้วน พร้อมค่าที่คาดว่าจะคืนกลับ สำหรับเว็บแอป ให้แสดงขั้นตอนหลักและอธิบายว่ามีเดโมออนไลน์หรือวิธีติดตั้งบนเครื่องหรือไม่
อย่าใช้ภาพหน้าจอเป็นคำอธิบาย API เพียงอย่างเดียว ผู้อ่านควรคัดลอกโค้ดได้ ในทางกลับกัน แอปเชิงภาพอาจได้ประโยชน์จากภาพหน้าจอพร้อมคำอธิบายชัดเจนว่าผู้ใช้กำลังทำอะไร ใช้ตัวอย่างจริงจากเวอร์ชันที่คุณเผยแพร่อยู่
- ไลบรารี: การติดตั้ง สภาพแวดล้อมรันที่รองรับ และการเรียกฟังก์ชันที่ครบถ้วนหนึ่งครั้ง
- CLI: ข้อมูลเข้า คำสั่ง ผลลัพธ์ และวิธีรายงานข้อผิดพลาด
- เว็บแอป: ลิงก์เดโมหรือการติดตั้งบนเครื่อง การตั้งค่า และภาพหน้าจองานหลัก
- ชุดข้อมูล: แหล่งที่มา รูปแบบ สัญญาอนุญาต และระเบียนตัวอย่างขนาดเล็ก
ตรวจสอบ README ก่อนแชร์
ทดลองคู่มือเริ่มต้นอย่างรวดเร็วในสภาพแวดล้อมสะอาด แทนเครื่องที่ตั้งค่าสำหรับพัฒนาไว้แล้ว ตรวจดูว่าต้องใช้แพ็กเกจส่วนกลางที่ไม่ได้ระบุ รีจิสทรีส่วนตัว หรือไฟล์บนเครื่องหรือไม่ หากต้องใช้บัญชีหรือบริการเสียเงิน ให้บอกก่อนคำสั่งแรก
เปิดลิงก์เอกสารและรูปภาพจากหน้าที่เก็บโค้ด ยืนยันว่าชื่อไฟล์คู่มือร่วมพัฒนาและสัญญาอนุญาตตรงกับที่เก็บโค้ด และลบลิงก์เสีย README ที่สั้นและถูกต้องดีกว่าแม่แบบที่ดูน่าประทับใจแต่เต็มไปด้วยคำสัญญาที่ยังไม่ได้ทำ
- ลบข้อความตัวแทนและคำกล่าวอ้างที่ไม่มีหลักฐาน
- อย่าใส่โทเคนจริง รหัสผ่าน หรือ URL ส่วนตัวในตัวอย่าง
- ตรวจสอบว่าผลลัพธ์ที่คาดหวังตรงกับเวอร์ชันที่เผยแพร่
- บอกผู้อ่านว่าควรแนบข้อมูลใดเมื่อแจ้งปัญหา
ใช้ README เป็นพื้นฐานของข้อความเปิดตัว
หลังกรอกแม่แบบเสร็จ ให้สกัดเป็นคำแนะนำสั้น ๆ: หนึ่งประโยคเกี่ยวกับปัญหา หนึ่งตัวอย่างผลลัพธ์ และหนึ่งลิงก์สำหรับทดลอง สิ่งนี้เป็นจุดเริ่มต้นของโพสต์ในชุมชน เก็บ README เดิมเป็นแหล่งข้อมูลละเอียด และปรับคำแนะนำแต่ละชิ้นให้เหมาะกับผู้อ่าน แทนการใช้ย่อหน้าโปรโมตเดิมทุกที่
คำถามที่พบบ่อย
นี่คือ README ของที่เก็บโค้ดหรือ README ของโปรไฟล์?
แม่แบบนี้สำหรับที่เก็บโค้ดซอฟต์แวร์ README ของโปรไฟล์ใช้แนะนำบุคคล จึงต้องมีส่วนที่ต่างออกไป เช่น ผลงานและช่องทางติดต่อที่ต้องการ
ควรเพิ่มป้ายจำนวนดาวไว้ด้านบนไหม?
เพิ่มเฉพาะเมื่อช่วยผู้อ่านได้ ให้จุดประสงค์และส่วนเริ่มต้นอย่างรวดเร็วเด่นชัด ป้ายไม่อาจแทนคำอธิบายว่าโครงการทำอะไร
ใช้แม่แบบนี้กับโครงการส่วนตัวได้ไหม?
ได้ แทนลิงก์ช่วยเหลือสาธารณะด้วยช่องทางช่วยเหลือที่ทีมใช้จริง อธิบายข้อกำหนดการเข้าถึง และอย่าใส่ข้อมูลรับรองในเอกสาร