การสร้างไฟล์ README


วิธีไฟล์ Readme.MD

Readme.MD เป็นไฟล์ที่มีอยู่ในรูทของที่เก็บและทำหน้าที่เป็นแนวทางเกี่ยวกับข้อมูลเกี่ยวกับที่เก็บและข้อมูลทั้งหมดเกี่ยวกับอะไร
โดยทั่วไปแล้ว Readme.MD เขียนด้วยภาษา Markdown
Markdowns เขียนง่ายและดูสวยงามเมื่อแสดงข้อความสุดท้าย

  1. หัวข้อ
    หากคุณต้องการเขียนหัวเรื่องขนาดใหญ่คุณสามารถใช้ไฟล์ # ตามด้วยข้อความ
  2. หัวข้อย่อย
    หากคุณต้องการลดขนาดหัวเรื่องให้เล็กลงกว่าเดิมคุณสามารถเพิ่มส่วนเพิ่มเติมได้ #.
    เช่น ##การติดตั้ง
    จากจำนวน # คุณต่อท้ายส่วนหัวก็จะยิ่งเล็กลง
  3. ข้อความ
    Normal Text นั้นเขียนได้ง่ายเพียงแค่เขียนโดยไม่มีการจัดรูปแบบใด ๆ และควรจะปรากฏเหมือนกับที่เป็นอยู่
  4. เชื่อมโยงหลายมิติ
    หากคุณต้องการเพิ่มไฮเปอร์ลิงก์ให้กับข้อความให้ใส่ลงในวงเล็บเหลี่ยมตามด้วยวงเล็บปกติที่มีลิงก์
    เช่น [จุดเล็ก ๆ](https://pip.pypa.io/en/stable/)
    pip ข้อความจะเชื่อมโยงกับ URL https://pip.pypa.io/en/stable/)
  5. ข้อมูลโค้ด
    ในการแสดงรหัสบล็อกให้ใช้ `` ที่จุดเริ่มต้นและจุดสิ้นสุดของบล็อกรหัส
    ```bash
    pip install foobar
    ```

    พูดถึงชื่อภาษาที่ด้านบนหลัง `` 'เพื่อเน้นไวยากรณ์
    เช่นทุบตีทับทิม ชวา, งูหลาม ฯลฯ

    ```python
    import foobarfoobar.pluralize('word') # returns 'words'
    foobar.pluralize('goose') # returns 'geese'
    foobar.singularize('phenomena') # returns 'phenomenon'
    ```

     

  6. เน้นคำ
    หากต้องการเน้นคำในข้อความให้ใส่คำว่า“““"
    เช่น `MySQL`.
    ด้านล่างจะให้ผลผลิตดังต่อไปนี้

ง่ายใช่มั้ย
READMEs ที่ดูน่าทึ่งที่สุดถูกสร้างขึ้นโดยใช้การจัดรูปแบบด้านบน
ลองสร้างของคุณเองและอัปเดตใน Git Repository

ด้านล่างนี้เป็นลิงค์ของ README ที่ยอดเยี่ยมและได้รับการดูแลจัดการที่คุณอาจต้องการดู
https://github.com/matiassingers/awesome-readme
ไปที่ลิงค์ด้านบนและคุณจะได้รับแนวคิดเกี่ยวกับวิธีการออกแบบ README ที่สวยงามสำหรับโครงการของคุณ

สรุป
ในบทช่วยสอนนี้คุณได้เรียนรู้วิธีสร้างไฟล์ README ที่ดูดีสำหรับที่เก็บของคุณ
ต่อไปเราจะมาดูวิธีสร้างไฟล์ .ignore เพื่อหยุดการติดตามไฟล์ที่ไม่ต้องการและถูกพุชไปยังที่เก็บ