[Readme change] make build -> make all, to get working build out of the box
Open
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 142
- Forks
- 41
- Avg merge
- 14h 30m
- Merged PRs (30d)
- 10
Description
When trying to set up the template, I followed the Readme indications, but it failed at
make build
Since the build recipe does not generate the git_sha.adoc file.
The correct command to make it work is
make all
Suggest to make the change in the readme, one shouldn't have to read the makefile to make it work ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Check the README instructions against the Makefile, focusing on the documented make build command and the git_sha.adoc generation mentioned in the issue. Update the README to use make all, then verify that the documented command produces a working build from a fresh setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100