V2EX  ›  英汉辞典

README

释义 Definition

README:项目/软件的“说明文件”,通常放在代码仓库或文件夹根目录,用来介绍项目用途、安装步骤、使用方法、依赖、贡献方式、许可证等。(也常写作 readmeREADME.md

发音 Pronunciation

/ˈriːd.miː/

例句 Examples

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 概述了项目目标,列出了所需依赖,并说明了如何在不同操作系统上运行测试套件。

词源 Etymology

来自英文短语 “read me”(“读我/请阅读我”),最初用作提示性文件名,提醒用户先阅读说明;在开源与软件开发文化中逐渐固定为标准文档名称,常以大写 README 出现。

相关词 Related Words

文学与著作中的用例 Notable Works

  • Pro Git(Scott Chacon & Ben Straub)
  • The Pragmatic Programmer(Andrew Hunt & David Thomas)
  • The Cathedral and the Bazaar(Eric S. Raymond)
关于   ·   帮助文档   ·   自助推广系统   ·   博客   ·   API   ·   FAQ   ·   Solana   ·   1502 人在线   最高记录 6679   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 6ms · UTC 16:35 · PVG 00:35 · LAX 08:35 · JFK 11:35
♥ Do have faith in what you're doing.