https://github.com/getwilds/makefiles
Makefile templates for WILDS projects
https://github.com/getwilds/makefiles
utilities
Last synced: 3 months ago
JSON representation
Makefile templates for WILDS projects
- Host: GitHub
- URL: https://github.com/getwilds/makefiles
- Owner: getwilds
- Created: 2023-10-31T18:37:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T17:30:59.000Z (over 1 year ago)
- Last Synced: 2025-03-19T21:49:27.662Z (over 1 year ago)
- Topics: utilities
- Language: Makefile
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
makefiles
=========
[](https://getwilds.github.io/badges/#prototype)
Makefile templates for WILDS projects.
- R
- Python
## What are these for?
A file called [Makefile][] (with no extension!) is a file used to run `make` targets. [make][] is a build automation tool. It's widely used, and can be used in projects regardless of the programming language(s) used in that project.
There's [many language specific tools][buildtools] that are similar to `make`. For example, Ruby has [Rake][] and the `Rakefile`, and R has [targets][]. However, using and getting familiar with `make` is worth it as it's useful regardless of the languages you're working on.
If a `Makefile` is in the root of a project, you should be able to type `make` and then a target, for example `make install` to install the package. Many terminal applications have plugins/extensions to tab autocomplete the make targets in the `Makefile`, which is a nice quality of life enhancement.
## How do I use these?
If you're working in an IDE like RStudio you may not find these Makefile's useful as the IDE has buttons and keyboard shortcuts that do a lot of what the Makefile does and more. Where a Makefile comes into play is when you are working in a terminal.
To use one of thes Makefile's, navigate to the file for either an R or Python package, and click the icon that says on hover "Download raw file". Put that file in the root of your project.
After downloading the Makefile, you can edit it however you like, add new targets, remove targets, edit targets, etc.
Important: Check if the paths used in various make targets are appropriate for your project, especially for Python projects where there's a lot more flexibility in structure of a package relative to R.
## Feedback
These Makefile's are a work in progress! Open an issue if you have any thoughts, comments, feedback.
[make]: https://en.wikipedia.org/wiki/Make_(software)
[Makefile]: https://en.wikipedia.org/wiki/Make_(software)#Makefiles
[rake]: https://en.wikipedia.org/wiki/Rake_(software)
[buildtools]: https://en.wikipedia.org/wiki/List_of_build_automation_software
[targets]: https://docs.ropensci.org/targets/