Add Makefile #41
Merged
Add Makefile #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Makefile help newcomers to understand what to do with project. By running: ```bash $ make help ``` or just ```bash $ make ``` there will be help message with all available commands. Help message parsed from Makefile itself, by finding `##` comments after command name. Currently usefull commands are: - *dep* - install dependencies and make vendoring folder - *test*- run unit tests, but before it runs `dep` - *build* - run test and build a binary into ./bin folder - *run* - just execute binary - *rerun* - build and run - *printvars* - print all variables available for make its usefull when you need to debug some settings On top of Makefile there are variables for all these commands, like: - PROJECT_NAME - BUILD_DIR - VERSION - BUILD_DATE - COMMIT_SHA - and LDFLAGS LDFLAGS used on binary compilation, to inject some build data and get this information inside app. Also this commit contains small changes in forming of version string There is a good practices to add version with git tags, but also a commit message and build date.
Closed
aryan9600
requested changes
Oct 3, 2020
Makefile
Outdated
| @@ -0,0 +1,45 @@ | |||
| # Build variables | |||
| PROJECT_NAME = $(shell basename "$(PWD)") | |||
| BUILD_DIR = bin | |||
There was a problem hiding this comment.
I think it'll be better to have the BUILD_DIR as the root of the project itself.
There was a problem hiding this comment.
I think it's easier to .gitignore folder with some files than just some files in the root of a project, perhaps in future you will generate several binaries for different operating systems, so you will need to add them in .gitignore or don't think about it, and just put bin folder there.
There was a problem hiding this comment.
Actually termiboard aims to ship one binary for all platforms, but after going through the articles (thanks for the links btw), I think it makes sense to have it a /bin folder. 👍
|
Added |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Makefile help newcomers to understand what to do with project.
By running:
$ make helpor just
there will be help message with all available commands.
Help message parsed from Makefile itself, by finding
##comments after command name.Currently usefull commands are:
depits usefull when you need to debug some settings
On top of Makefile there are variables for all these commands, like:
LDFLAGS used on binary compilation, to inject some build data
and get this information inside app.
Also this commit contains small changes in forming of version string
There is a good practices to add version with git tags, but also
a commit message and build date.