Stack Overflow
Stack Overflow

Questions tagged [readme]

A readme file is a file that contains information about something that should be read, generally before use.

A readme file is a file that contains information about something that should be read, generally before said thing should be used. These files can appear in many different formatting, including (readme.md), and plain text (readme.txt or sometimes just readme with no extension).

349 questions
3228
votes
44 answers

How to add images to README.md on GitHub?

Recently I joined GitHub. I hosted some projects there. I need to include some images in my README File. I don't know how to do that. I searched about this, but all I got was some links which tell me to "host images on web and specify the image path…
Midhun MP
  • 103,496
  • 31
  • 153
  • 200
509
votes
23 answers

How to add color to GitHub's README.md file

I have a README.md file for my project underscore-cli, and I want to document the --color flag. Currently, the only way to do this is with a screenshot (which can be stored in the project repository): But screenshots aren't text, preventing readers…
Dave Dopson
  • 41,600
  • 19
  • 95
  • 85
425
votes
6 answers

New lines inside paragraph in README.md

When editing an issue and clicking Preview the following markdown source: a b c shows every letter on a new line. However, it seems to me that pushing similar markdown source structure in README.md joins all the letters on one line. I'd like the…
zoran119
  • 10,657
  • 12
  • 46
  • 88
177
votes
1 answer

How do you indent a bulleted list in a README file using GitHub flavored markdown?

I know I can use asterisks to do something like this: list item1 list item2 but I was expecting something like ** to indent it one further. Is it possible?
Alaa Awad
  • 3,612
  • 6
  • 25
  • 35
143
votes
8 answers

How to display Table in README.md file in Github?

I want to display a table in readme.md file. I read GitHub Flavored Markdown and followed what it said. So this is my table: | Attempt | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | #9 | #10 | #11 | #12 | | :---: | :---: | :---: | :---: | :---: | :---: |…
Hesam
  • 52,260
  • 74
  • 224
  • 365
64
votes
5 answers

Github include md files in README.md?

Is there a way in Github to include md files in for example the README.md? # Headline Text [include](File:load_another_md_file_here.md) It should not link to the file, it should load the contents from it, like PHP include / file_get_contents.
Jens Törnell
  • 23,180
  • 45
  • 124
  • 206
60
votes
4 answers

How to force image (cache) update in README.rst on GitHub

In one of my project I'm using an external image link to display a screenshot via the GitHub page, which automatically parses the README.rst GitHub page of ROyWeb I updated this screenshot on my web server several times in the last weeks and I just…
tamasgal
  • 24,826
  • 18
  • 96
  • 135
45
votes
4 answers

Add image with link in Github's README.md?

How to add an image that is also a link to an external page on Github's README.md? Adding a markdown to display an image is pretty simple (answer at Add images to README.md on GitHub). Adding a link is also pretty simple (GitHub relative link in…
Rafael Borja
  • 4,487
  • 7
  • 29
  • 33
40
votes
5 answers

How do I add images to a PyPI readme (that works on GitHub)?

In my readme on GitHub I have several images that are present there in my project's source tree which I reference successfully with directives like .. image:: ./doc/source/_static/figs/moon_probe.png I would also like to have these images appear…
orome
  • 45,163
  • 57
  • 202
  • 418
39
votes
2 answers

Relative Link to Repo's Root from Markdown file

I need to have a relative link to root of my repo from markdown file (I need it working for any forks) So it looks like the only way it's to provide a link to some file in the root: the [Root](/README.md) or the [Root](../README.md) (if it's located…
Oleg Pro
  • 2,323
  • 1
  • 15
  • 23
38
votes
1 answer

How can I use a pdf file as the readme in my github repo?

I have a pdf file generated by latex which has many equations and what not. I want to use this pdf as the readme.md file in my github repo. How can I do this? Alternatively, is it possible to directly integrate the tex file in github and use that…
JRun
  • 669
  • 1
  • 10
  • 17
37
votes
3 answers

How to push a docker image with README file to docker hub?

I am trying to push a docker image to my private repo on docker hub. However, I do see that there is an "Information" section on the Docker Hub which I want to update with useful information about my image. I am wondering if I can push a README.md…
sunsin1985
  • 2,437
  • 5
  • 22
  • 27
24
votes
5 answers

How to install Mermaid to render flowcharts in markdown?

I'm trying to render a flowchart in a markdown file using Mermaid. I have a ReadMe.md file in my GitHub repository, and I'd like to include a basic flowchart to help describe the contents. But I can't figure out how to get it to work. Would…
AlexP
  • 577
  • 1
  • 4
  • 15
24
votes
2 answers

Images in a table with GitHub markdown

I'm having some problems formatting a README on github. This is the raw README: | Italic | Block letters…
Luca
  • 801
  • 1
  • 6
  • 11
23
votes
2 answers

Add audio in Github readme.md

Is there a way to add an audio bar in the Github readme.md? I want to be able to play a certain mp3 file directly through the readme.md, rather than be directed to some soundcloud or youtube link.
Sarthak Agarwal
  • 404
  • 1
  • 3
  • 13
1
2 3
…
23 24