问题标签 [readme]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
visual-studio - 解决方案根目录中的 Visual Studio 2013 Pro README.md
在 Visual Studio 2013 Pro 中，有没有办法为根解决方案提供 README.md？我们有一个相当大的解决方案，我正在尝试创建一个主要的 README.md，它可以提供每个项目的介绍以及指向它们的 README 的链接。
docker - 如何将带有 README 文件的 docker 映像推送到 docker hub？
我正在尝试将 docker 映像推送到 docker hub 上的私人仓库。但是，我确实看到 Docker Hub 上有一个“信息”部分，我想用关于我的图像的有用信息来更新它。我想知道我是否可以推送一个 README.md 文件，Docker Hub 可以解析这个文件并用它更新“信息”部分。我不确定是否应该将 README.md 嵌入到我的图像中以使其正常工作？
github - 如何将链接图像添加到 GitHub README 中的视频？
我一直在尝试将我的 Java 项目的屏幕截图嵌入到项目存储库的 GutHub README 中。我遇到的解决方案是使用链接图像，但我创建的链接不显示缩略图或视频链接。
我已经完全按照 Stackoverflow 问题中的解决方案进行了操作，但看不到错误在哪里。我首先得到了我单独检查的缩略图和视频链接，两者都是有效的。
有谁知道我在添加此链接图像时哪里出错了？下面的屏幕截图显示了它在 GitHub 上的显示方式：
这是我创建的链接：
git - 有没有办法在 Github README.md 中添加指向当前仓库的链接？
我的大多数 repos 的 README.md 文件都包含有关如何克隆/构建/运行/测试代码的说明：
问题是链接是特定于 repo 的，即如果 repo 已被分叉/转移，则 README 仍将包含指向我原始 repo 的链接。我遇到了至少一个案例，有人分叉了一个 repo，然后复制/粘贴了安装说明，但不明白为什么不存在更改。
我的问题：有什么方法可以在 README 文件中添加指向当前仓库的链接？这样在克隆时会指向克隆的仓库吗？
annotations - 在登录 bitbucket REAME 文件时（可能还有更多）
我编写了使用 Bitbucket 存储库维护的 Java 代码。现在，在编写我的 README 并描述一些 Java 注释时，即
…README 降价文件将这些解释为指向其他用户的链接，这非常令人沮丧。由于似乎不支持内联 HTML（我尝试过“@”=@），有没有人可以在这些 README 文件中编写文字符号？
github - Github README 渲染 Gliffy 图表
有没有办法在 github repo 的 README 中添加一个 gliffy 图？我知道如何添加图像，并且我已经尝试过使用 gliffy 图表的方法，但它不起作用；gliffy 不渲染。也许正确的问题是，github README 是否有一个闪烁的渲染器？
编辑：
我真正想要的是可能将 gliffy xml 存储在 repo 中，当被引用时，它将自动在 README 中呈现，而不是将 xml和预渲染图像存储在 repo 中。
git - git repo 中的 README.md 文件有什么作用？
我们一直在为项目使用 git 存储库。我们还从那里下载了一些代码（比如示例代码）。
我在每个存储库上都找到了 ReadMe.md 文件。
为什么会在那里？以及.md的含义是什么？
每个文件夹也包含该文件一段时间。为什么人们在 git 存储库中添加该文件？
我没有任何想法，我想在我开始使用 git 进行代码源管理时了解它。
github - Github 工具来验证 Markdown 中的链接
我计划在我的一些README.md文件中做的是提供指向我引用的其他网站的超链接。但是，当链接死亡或移动时，我们都会遇到这个问题，并且所述链接变得无效。=(
是否有一个 github 工具可以运行夜间检查以查看README.md文件中的所有链接（或类似的东西）是否正常工作？
我正在寻找的是具有类似于 Travis CI 的功能的东西，其中项目可以在项目的主 github 页面上显示“链接传递”的徽章。（例如：scikit-learn有这两个看起来很优雅的“构建传递”徽章。）
r - 如何为自述文件中的输入生成 table.file：用于自动内容分析的软件
我正在尝试使用Hopkins 等人的自述包。但无法让它与我自己的数据一起使用。演示运行良好，我按照包的预期转换了我的数据（每个文本的单独 txt 文件和带有真实标签的 control.txt 文件等等）。我没能做的是创建 table.file。表格文件包含一个词频表，演示文件在 Excel 中打开时如下所示：
不幸的是，似乎没有任何关于如何创建这样一个 table.file 的文档。文档只说：
table.file：应存储词频表的文件路径。默认为“tablefile.txt”。当然，用户必须对这个文件有读写权限，文件之前的内容会被覆盖。
任何人都可以指出产生此类文件的程序或代码吗？还是我错过了文档中的某些内容？
github - Github 是否支持 Readme.md 中的用户名变量？
我有一个存储库，其中包含来自 Travis-CI 的徽章。根据 Travis-CI 文档的建议，此徽章包含在 Readme.md 中，并带有以下链接：
[](https://travis-ci.org/nikicc/orange3-text)
然而，现在每个分叉我的 repo 的人都将获得我的Travis-CI 徽章的链接，因为它与我的用户名一起被硬编码。我想实现所有叉子都自动拥有指向他们徽章的链接，而不是我的。是否有可能通过在 Github 上的 Readme.md 文件中使用一些变量作为存储库的用户名来绕过这个？有什么好的解决方案吗？