我需要在README文件中包含一些图像。我不知道该怎么做这样做。

我创建了一个小向导，允许您为GitHub存储库的自述文件创建和自定义简单的图像库：请参阅ReadmeGalleryCreatorForGitHub。

该向导利用了GitHub允许img标签出现在README.md中的事实。此外，该向导还利用了将图像上传到GitHub的流行技巧，方法是将图像拖放到问题区域（如本主题的一个答案中所述）。

比这简单得多。

只需将图像上传到存储库根目录，并链接到没有任何路径的文件名，如下所示：

![Screenshot](screenshot.png)

许多张贴的解决方案都不完整或不合我的口味。

像imgur这样的外部CDN为该链添加了另一个工具。无聊的。在问题跟踪程序中创建虚拟问题是一种黑客行为。它会造成混乱，让用户感到困惑。将此解决方案迁移到fork或脱离GitHub是一件痛苦的事。使用gh-pages分支会使URL变得脆弱。另一个在维护gh页面的项目中工作的人可能不知道一些外部信息，这取决于这些图像的路径。gh-pages分支在GitHub上有一个特殊的行为，这对于托管CDN图像是不必要的。在版本控制中跟踪资产是一件好事。随着项目的发展和变化，管理和跟踪多个用户的变化是一种更可持续的方式。如果图像适用于软件的特定版本，则最好链接不可变图像。这样，如果稍后更新图像以反映软件的更改，任何阅读该版本自述文件的人都会找到正确的图像。

受这一要点启发，我的首选解决方案是使用带有特定修订永久链接的资产分支。

git checkout --orphan assets
git reset --hard
cp /path/to/cat.png .
git add .
git commit -m 'Added cat picture'
git push -u origin assets
git rev-parse HEAD  # Print the SHA, which is optional, you'll see below.

构造一个“永久链接”到图像的这个版本，并将其包装在Markdown中。

然而，手动查找提交SHA是不方便的，因此，作为快捷键，按Y键可以永久链接到特定提交中的文件，正如这个help.github页面所说的那样。

要始终显示资产分支上的最新图像，请使用blob URL：

https://github.com/github/{repository}/blob/assets/cat.png 

（从同一个GitHub帮助页面，文件视图显示分支上的最新版本）

只需在里面的README.md文件中写下代码[Anyname]（图像路径）

![Screenshot](screenshot1.png)

你可以这样做：

git checkout --orphan assets
cp /where/image/currently/located/on/machine/diagram.png .
git add .
git commit -m 'Added diagram'
git push -u origin assets

然后，您可以在README文件中引用它，如下所示：

![diagram]（diagram.png）

您可以使用替代的github CDN链接从README.md（或外部）链接到项目中的图像。

URL将如下所示：

https://cdn.rawgit.com/<USER>/<REPO>/<BRANCH>/<PATH>/<TO>/<FILE>

我的项目中有一个SVG图像，当我在Python项目文档中引用它时，它不会呈现。

项目链接

以下是文件的项目链接（不渲染为图像）：

https://github.com/jongracecox/anybadge/blob/master/examples/awesomeness.svg

嵌入图像示例：

原始链接

以下是指向文件的RAW链接（仍然无法渲染为图像）：

https://raw.githubusercontent.com/jongracecox/anybadge/master/examples/awesomeness.svg

嵌入图像示例：

CDN链接

使用CDN链接，我可以使用（渲染为图像）链接到文件：

https://cdn.rawgit.com/jongracecox/anybadge/master/examples/awesomeness.svg

嵌入图像示例：

这就是我如何在README.md文件和PyPi项目reStructedText doucmentation（此处）中使用项目中的图像