Readme.txt so với README.txt

Tôi vừa rẽ nhánh một dự án trong Github, thực hiện các thay đổi của mình, v.v ... Điều này khiến tôi băn khoăn: Tôi thấy phần lớn README.txt trong các dự án mã nguồn mở và tệp tôi đã chỉnh sửa là Readme.txt. Đây có phải là một số loại nổi bật hay tôi nên để nó như vậy?

Các chữ cái viết hoa nổi bật và làm cho tập tin dễ dàng nhìn thấy, điều này có ý nghĩa bởi vì đó có lẽ là điều đầu tiên người dùng mới muốn xem xét. (Hoặc, ít nhất, nên đã xem qua) Như những người khác đã nói, tên tệp bắt đầu bằng chữ in hoa sẽ được liệt kê trước tên viết thường trong phân loại ASCIIbory ( LC_COLLATE=C) giúp hiển thị tệp ngay từ cái nhìn đầu tiên.

Các READMEtập tin là một phần của một loạt các file một người sử dụng một gói phần mềm miễn phí thường mong chờ để tìm. Các phần khác là INSTALL(hướng dẫn xây dựng và cài đặt phần mềm), AUTHORS(danh sách người đóng góp), COPYING(văn bản giấy phép), HACKING(cách bắt đầu đóng góp, có thể bao gồm danh sách điểm bắt đầu TODO), NEWS(thay đổi gần đây) hoặc ChangeLog(chủ yếu là dự phòng với hệ thống kiểm soát phiên bản).

Đây là những gì mà Tiêu chuẩn mã hóa GNU phải nói về READMEtệp.

Phân phối phải chứa một tệp có tên READMEtổng quan chung về gói:

• tên của gói;
• số phiên bản của gói hoặc tham khảo nơi có thể tìm thấy phiên bản trong gói;
• một mô tả chung về những gì gói làm;
• một tham chiếu đến tệp INSTALL, trong đó sẽ lần lượt chứa một lời giải thích về quy trình cài đặt;
• một lời giải thích ngắn gọn về bất kỳ thư mục hoặc tệp cấp cao bất thường nào, hoặc các gợi ý khác để người đọc tìm đường đi quanh nguồn;
• một tham chiếu đến tệp chứa các điều kiện sao chép. GNU GPL, nếu được sử dụng, phải nằm trong một tệp có tên COPYING. Nếu GNU LGPL được sử dụng, nó sẽ nằm trong một tệp có tên COPYING.LESSER.

Vì luôn luôn tốt để phấn đấu cho người dùng ít ngạc nhiên nhất, bạn nên tuân theo quy ước này trừ khi có những lý do thuyết phục cho sự sai lệch. Trong thế giới UNIX, các phần mở rộng tên tệp thường được sử dụng một cách tiết kiệm để tên chính thức của tệp READMEkhông có bất kỳ hậu tố nào. Nhưng hầu hết người dùng có thể sẽ không gặp khó khăn khi hiểu rằng một tệp có tên README.txtcó cùng ý nghĩa. Nếu tệp được viết bằng Markdown , tên tệp như thế README.mdcũng có thể hợp lý. Tránh sử dụng các ngôn ngữ đánh dấu phức tạp hơn như HTML trongREADMEtuy nhiên, vì nó thuận tiện để đọc trên thiết bị đầu cuối chỉ có văn bản. Bạn có thể trỏ người dùng đến hướng dẫn sử dụng phần mềm hoặc tài liệu trực tuyến của phần mềm, có thể được viết bằng định dạng phức tạp hơn, để biết chi tiết từ READMEtệp.

Theo truyền thống, tệp được gọi là README bằng chữ in hoa vì môi trường dòng lệnh sử dụng thứ tự chữ cái sau đó sẽ đặt tệp ở trên cùng. Điều này làm cho chúng dễ dàng nhìn thấy trong các thư mục lớn.

Rất có thể đó là một sự tiếp quản từ thế giới Unix / Linux nơi bạn sẽ tải xuống các nguồn và sau đó xây dựng phần mềm của mình. Có các tệp như README và INSTALL ở đầu chế độ xem 'danh sách nội dung thư mục' của bạn giúp dễ dàng thấy rằng chúng ở đó, thay vì phải duyệt toàn bộ nội dung từ giao diện dòng lệnh. Nguyên tắc cơ bản tương tự cũng hoạt động với github (và thực tế cũng hoạt động trong giao diện GUI, hãy nghĩ về nó, vì vậy nó vẫn có thể có công)

Không phải là một quy tắc khó khăn, nhưng rất có thể một cái gì đó mà mọi người đang làm như một thói quen bởi vì các dự án khác đang làm điều đó. Trừ khi có một số lý do rõ ràng KHÔNG, bạn có thể nên sử dụng tất cả các mũ chỉ vì bạn sẽ thấy nó được sử dụng theo cách đó trong nhiều dự án khác. Đây cũng là cách đặt tên mặc định mà Github sử dụng khi bạn tạo một kho lưu trữ mới.

README thường được viết bằng chữ in hoa Theo cách này, lslệnh Unix đã đặt tệp gần đầu danh sách thư mục (các chữ cái viết thường xuất hiện trước các chữ cái viết thường theo thứ tự ASCII).