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
22
votes
5 answers

How to specify different readme files for github and npm

Both use the README.md as the description when you publish. A common practice is to use a single shared file. But what if I need to have the different Readme and still publish it from a single local repo with no manual editing/replacement PS I…
Oleg Pro
  • 2,323
  • 1
  • 15
  • 23
22
votes
4 answers

How do I use the 'logo' option in shields.io badges?

How do I use the logo option in shields.io badges? For example, something like this [![Raspberry…
orome
  • 45,163
  • 57
  • 202
  • 418
21
votes
1 answer

Add multiple README on GitHub repo

Is it possible to add multiple README on a git repository? To write a french and a english file for example (README.fr.md, README.en.md). (Of course, I know it's possible but it's not recognized by GitHub as a README.)
IT-bob
  • 316
  • 1
  • 2
  • 8
20
votes
2 answers

Using Gitlab Variables in Gitlab README.md for SonarQube Badges

I'm using Gitlab and Sonarqube and the Sonarqube Plugin SVG Badges. To represent the Sonarqube state on gitlab I have something like this in my README.md…
Joergi
  • 1,527
  • 3
  • 39
  • 82
18
votes
1 answer

FontAwesome on GitHub flavored markdown

I want to know the best way to represent FontAwesome icons on GitHub flavoured markdown. Currently What I do is I include the path for my compiler to find FontAwesome and Academ-icons. link rel="stylesheet"…
senior_mle
  • 809
  • 1
  • 10
  • 20
18
votes
1 answer

What file types does GitHub support for README's

I have noticed that many different file types are used for GitHub READMEs. The most common ones are .md and .rst After looking at the GitHub documentation and the help page I found no information on which file types are allowed. I am just looking…
William V.
  • 515
  • 5
  • 24
16
votes
2 answers

Big gif from a third party site does not show in the README.md of github?

I want to show a gif in a README.md of github. And it works fine when the target gif is small with: but when the gif is big, it is not showing as expected, take this gif as an example. When I add it into…
AssIstne
  • 466
  • 4
  • 13
16
votes
1 answer

How can I edit the markdown font colors in Eclipse Luna?

For dark color schemes in eclipse, the default markdown colors are hard to read. This makes it difficult to edit README.md files, for example. It took me a while to find the right setting to change font color and thought I would share the answer.
Andrew Johnston
  • 1,109
  • 6
  • 11
15
votes
2 answers

Display PDF in GitHub Markdown

This is quite similar to what is being asked in this post, but the post does not seem to work for GitHub's parsed Markdown. Simply put, let us say I have a PDF in a GitHub repository. Is there any way to render/embed that in a markdown file that is…
Gigi Bayte 2
  • 838
  • 1
  • 8
  • 20
15
votes
1 answer

how can i put fontawesome icons in markdown ? (readme file that will be uploaded to github)

I want to put some fontawesome icons in my readme to explain what they mean in my website but markdown doesnt allow css so is there a way I can overcome this? This is where I got the icon This would be the html This is…
Tony
  • 387
  • 1
  • 2
  • 14
14
votes
6 answers

How to use margin/padding in GitHub README.md?

Issue I'm trying to display several images in GitHub's README.md with a margin of x px between them. But for some reason GitHub seems to strip away the margin-right: 30px style. Markdown [
Vinay Sharma
  • 3,291
  • 4
  • 30
  • 66
14
votes
1 answer

How to insert a horizontal line in a README.md file

I am trying to insert a horizontal line in a README.md file and I don't know how to.
Alexander Bolte
  • 531
  • 4
  • 10
13
votes
6 answers

How to add README.md on github but not have same README.md in home directory while using a bare git repository for managing dotfiles?

I manage my dotfiles using git in a bare repository. See article by Harfang Perch for details on this method. It works great but I'd like to add a README.md to the root of the repository on github. How do I add a README.md to the github repository…
makeyourownmaker
  • 1,558
  • 2
  • 13
  • 33
12
votes
1 answer

Visual Studio 2013 Pro README.md in solution root

In Visual Studio 2013 Pro, is there a way to have a README.md for the root solution? We have a rather large solution and I'm trying to create a main README.md that can give an intro of each of the projects and a link to their READMEs.
samanime
  • 25,408
  • 15
  • 90
  • 139
11
votes
3 answers

Changing README.md image display conditional to GitHub light-mode / dark-mode

Is it possible to change README.md image display in GitHub that is conditional to GitHub's dark-mode and light-mode? Perhaps a simple conditional I can put in my README.md.
irahorecka
  • 1,447
  • 8
  • 25
1
2
3
…
23 24