Closed michalfabik closed 4 years ago
I'm not sure HACKING.md
is the right name for this file. I'd search for this either in BUILDING
or in the readme (which could use some modernisation anyway).
I suppose you could also add a badge for the build action at the top, just to make it a little fancier, like this
![Build](https://github.com/abrt/satyr/workflows/Build/badge.svg)
One last thing: You need to add the .md
extension to make sure the readme renders as Markdown.
You need to add the .md extension to make sure the readme renders as Markdown
That's precisely what I wanted to do first of all. But no, surely README
on its own is a well-established convention and GitHub is smart enough to figure out Markdown anyway, better not tamper with it. Oh well.
A minimal version of build instructions. Nothing interesting here, it's just that every project uses a slightly different method and I keep forgetting and digging around looking for a HOWTO.
Signed-off-by: Michal Fabik mfabik@redhat.com