viet-readme-writer
Viết README để người lạ star hoặc clone được, không phải tiểu luận.
Khi nào dùng
- Repo mới chưa có README tử tế
- README hiện tại toàn badge và slogan
- Cần bản VI, EN, hoặc VI+EN
Không dùng
- Docs API đầy đủ (để file
docs/) - Changelog
Bước
- Đọc code, script start, license, stack thật. Không bịa tính năng.
- Fold đầu — một câu repo làm gì, 1 lệnh chạy, ví dụ, bảng lệnh.
- Tiếng Việt ngắn. Thuật ngữ kỹ thuật giữ EN.
- Xóa “chào mừng bạn đến với”, “được xây dựng nhằm mục đích”.
Ví dụ fold
doi-ten
Đổi tên hàng trăm file theo pattern, chạy local, không upload.
Checklist
- Câu đầu không chứa “awesome”, “powerful”
- Lệnh chạy thật
- Không bịa screenshot