Nên đổi tên index.md sang README.md

daynhauhoc / cppcoban

Nội dung khóa học C++ Cơ bản

http://daynhauhoc.com/t/24016

41 stars 23 forks source link

Nên đổi tên index.md sang README.md #19

Open Maskma opened 8 years ago

Maskma commented 8 years ago

Em thấy một số repo sách người ta để từng bài một folder và content file là README.md nên khi vừa vào folder nó hiển thị luôn content file. Em nghĩ nên đổi từ index.md sang README.md vì nhiều folder có tên ảnh lung tung làm cái index.md nó cũng nhảy lung tung.

thangngoc89 commented 8 years ago

Cảm ơn bạn . Mình biết là đặt tên file là README.md thì khi truy cập vào thư mục, Github sẽ tự động hiển thị file đó. Tuy nhiên mình đang để là index.md để có thể build website dễ dàng. Mình sẽ chuyển thành README.md nếu giải quyết được vấn đề build trên website.

Website repo: https://github.com/thangngoc89/dnh-cpp

thangngoc89 commented 8 years ago

Chính xác là mình muốn làm cái này. Sẽ giữ issue mở

dinhquochan commented 8 years ago

Thông thường các Readme dùng để giới thiệu, hướng dẫn,.. về vấn đề trong các file hiện tại, việc dùng file index.md là chuẩn rồi đó. Một project chỉ nên có 1 file README chung thôi. Ý kiến của mình là như thế.