README:项目/软件的“说明文件”,通常放在代码仓库或文件夹根目录,用来介绍项目用途、安装步骤、使用方法、依赖、贡献方式、许可证等。(也常写作 readme 或 README.md)
/ˈriːd.miː/
Please check the README before installing the program.
安装程序之前请先查看 README。
The README outlines the project’s goals, lists required dependencies, and explains how to run the test suite on different operating systems.
README 概述了项目目标,列出了所需依赖,并说明了如何在不同操作系统上运行测试套件。
来自英文短语 “read me”(“读我/请阅读我”),最初用作提示性文件名,提醒用户先阅读说明;在开源与软件开发文化中逐渐固定为标准文档名称,常以大写 README 出现。