Search
本篇文章主要探討的是如何打造一個 GitHub 個人帳號的 README 檔案。
作者因為某份職缺招募者告訴他，我們看了很多你的 GitHub 紀錄，建議寫一個 READEME 來好好的介紹你自己，因此作者開始思考如何透過 README 來好好的銷售自己展示自己的能力。
去年開始所有 GitHub 帳號都可以創造一個基於自己名稱的 repo，並且該 repo 內的 README 則會是自己帳號首頁的自我介紹，而本文則是示範如何設計一個有特色的 README 內容，從排版，選色，字型等議題都有所涉略
有興趣的也可以參考這個網站: https://awesomegithubprofile.tech/
裡面列出了非常多有趣很酷的 README，必須說很多都超乎我的想像.....
https://emmanueljose.medium.com/readme-a-makeover-story-b9c7be37a6de
🔥 "ใครกำลังใช้ GitHub เป็นหนึ่งในหน้าตา Resume ตัวเอง จนถึง ทำให้เพื่อน ๆ ใช้ต้องมาดู"
.
เพราะเราได้รวมเทคนิคดี ๆ ในการเขียน README.md มาไว้ให้เพื่อน ๆ ทุกคนแล้วนั่นเองง <3
.
โดยเรามี 7 เทคนิคดี ๆ จาก freeCodeCamp เว็บไซค์ความรู้ด้านการเขียนโปรแกรมมาสรุปให้ทุกคนเข้าใจง่าย ๆ ดังนี้ ถ้าพร้อมแล้ว ไปลุยกันเลย !!
.
👉 เทคนิคที่ 1 "ระบุชื่อ และ คำอธิบายโปรเจคให้ชัดเจน"
"เพราะคนเห็นจะได้รู้ได้ทันทีว่าโปรเจคนี้มีหน้าที่ไว้ทำอะไร
ใช้เทคโนโลยีอะไรบ้าง รวมถึงฟีเจอร์หลักที่คุณอยากโชว์"
.
👉 เทคนิคที่ 2 "ถ้าคิดว่าจะเขียนยาว ใส่สารบัญลงไปด้วย !!"
"มันก็คือ Table of Contents นั่นแหละ ! ถ้าเราจะใส่หัวข้อใหญ่ลงไปเยอะ ๆ แนะนำเลยว่าเจ้าตัวนี้มันสำคัญมาก (และ อย่าลืมทำลิงก์ไว้ด้วยนะ)
.
👉 เทคนิคที่ 3 "วิธีการติดตั้งโปรเจคของเรา"
"เพราะเราหลายคนคงเคยเจอโปรเจคที่อยากมาใช้ต่อ แต่งงเป็นไก่ตาแตก
เพราะไม่รู้จะใช้ยังไง อย่าลืม ! ขั้นตอนนี้สำคัญมาก ทำเป็น Step-by-Step เลยนะ!"
.
👉 เทคนิคที่ 4 "อย่าลืมวิธีใช้ด้วยนะเฮ้ยย !"
"ถ้าไม่มีแล้วจะใช้ยังไงหละนี่ ดังนั้นควรมีตัวอย่างการใช้งานเบื้องต้นให้ด้วย เช่น คลิกตรงไหน, เรียกใช้คำสั่งอะไร แบบเบื้องต้น (ถ้าเยอะ ๆ ไปใส่ใน Doc ก็ได้)"
.
👉 เทคนิคที่ 5 "ใส่เครดิตให้ชัด ๆ"
"ถ้ามีใครเข้ามาร่วมช่วยทำ หรือ นำ Project ของคนอื่นมาใส่ จนถึง งานวิจัยต่าง ๆ ก็ใส่ Link ไว้เป็นรายการใน Project ได้เลย"
.
👉 เทคนิคที่ 6 "อย่าลืมลิสต์รายการลิขสิทธิ์ด้วย"
"เพราะหลายครั้งเรานำของจากข้างนอกมา สัญญา อาจจะไม่เหมือนกับของเรา ก็ให้ระบุให้ชัดเจน เพราะนอกจากช่วยให้คนอื่นรู้ ยังช่วยเตือนความจำเราด้วยนะ"
.
👉 เทคนิคที่ 7 (อันนี้แถม) "ใส่รูปภาพประกอบทุกครั้งเมื่อมีผลลัพธ์"
"สิ่งที่เห็นภาพชัดที่สุดก็คือภาพนี่แหละ ! ถ้ามันชัดว่า Run แล้วผลเป็นแบบไหน บอกเลยว่างานเราจะเด็ดขึ้นเป็นกองภูเขาเลยคร้าบบบ !!"
.
บอกเลยว่านี่แค่ Basic เบื้องต้น เท่านั้น แต่แค่นี้ก็เพียงพอสำหรับสร้างผลงานระดับโลกแล้วหละ <3
.
ปล.ว่าแต่ใครมีเทคนิคเขียนยังไง หรือ ชอบ Readme ของเจ้าไหน เอามาอวดกันใต้โพสต์ได้เลยคร้าบบบบ !
.
borntoDev - 🦖 สร้างการเรียนรู้ที่ดีสำหรับสายไอทีในทุกวัน
讓 Github 自動更新你的 profile
https://simonwillison.net/…/10/self-updating-profile-readme/
不過我後來發現，按下github的RAW，可以看到README.md完整的寫法， 連下載都不用下載，真棒... 按了RAW之後會轉到下一 ... ... <看更多>
README 檔案字尾名為md。md是markdown的縮寫，markdown是一種編輯部落格的 ... 開啟你的GitHub的某個專案，我們可以直接線上編輯你的README檔案，如果 ... ... <看更多>
github readme 在 About READMEs - GitHub Docs 的推薦與評價
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license, citation file, ... ... <看更多>
相關內容