README là gì? README là một file dùng để mô tả các thông tin của dự án, giúp chúng ta tiếp cận dự án một cách nhanh nhất hoặc đơn giản hiểu về dự án này đang làm gì.

Tại sao lại cần README

Gần như tất cả các dự án mã nguồn mở đều có README, các bạn có thể xem qua một vài README của các dự án lớn:

Vậy tại sao lại cần README? README chính là cách mà người ta sẽ đọc đầu tiên khi tiếp cận một dự án mới, nó chứa những thông tin quan trọng về dự án của bạn.

Các thành phần của README

Tên của dự án

Nên đặt tên cho dự án của bạn để có thể phân biệt với các dự án khác. Tên của dự án và tên của repository thường sẽ giống nhau, điều này làm cho người khác cũng dễ tìm kiếm dự án của bạn.

Giới thiệu hoặc tóm tắt

Đây cũng là một phần quan trọng, bạn nên viết một vài dòng để mô tả về dự án của bạn đang làm gì. Thường thì phần này sẽ được viết ngay bên dưới tên của dự án.

Cách cài đặt

Đây là phần mà bạn sẽ hướng dẫn cách cài đặt dự án của bạn, ví dụ như cài đặt các thư viện để chạy dự án của bạn. Nếu việc cài đặt bao gồm nhiều bước thì bạn nên đánh số thứ tự các bước cài đặt để người sử dụng tiện theo dõi.

Cách sử dụng

Phần này bạn sẽ giới thiệu cách sử dụng dự án của bạn. Mình để ý thấy thường người ta sẽ demo một vài đoạn code đơn giải vào đây để chúng ta có thể tiếp cận dự án một cách nhanh nhất. Bạn cũng có thể liên kết một số tài liệu vào đây, để họ có thể flow.

Cách để đóng góp

Mô tả cách để đóng góp vào dự án của bạn, nếu hướng dẫn đóng góp dài thì bạn nên viết trong một file khác rồi link vào README.

Danh sách contributors

Bạn sẽ để danh sách những người đã đóng góp vào dự án của bạn, đây cũng là một cách để tôn vinh những đóng góp của họ.

Giấy phép

Có nhiều loại giấy phép, bạn nên cân nhắc để chọn giấy phép sao cho hợp lý.

Bonus: Đây là một dự án cho phép bạn tạo nhanh README.