Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

introduce Makefile #28

Open
marc-portier opened this issue Jul 26, 2022 · 1 comment
Open

introduce Makefile #28

marc-portier opened this issue Jul 26, 2022 · 1 comment

Comments

@marc-portier
Copy link
Member

related to #27

introduce a Makefile that creates a recurring common way of interacting with this project (and similar ones) regardless of the tool-chain it uses

The controbutorsmd documentation should then start by listing these make targets - and only later explore the details behind it

useful targets (comming from the py cookiecutter) to consider

  • make init --> check and install dependencies and needed libraries
  • make test --> run tests
  • make dist --> build a distro that can be pacakged, shipped, deployed
  • make check --> do code-checks, lint reporting, ...
  • make docs --> generate documentation

in this case it might also be useful to have something around that wraps launching the services ? make run - make start - make stop ?

@johannesnauta
Copy link
Contributor

johannesnauta commented Oct 25, 2022

For Linux installs a Makefile is most likely a good idea, at least initially. For Windows an .exe would be superior as people can just double click it and for MacOS I have no idea.

I would focus first on

  • make init or make install
  • make test
  • make docs

The other ones are less important (in my opinion) and should be saved for later milestones down the line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants