An integrated set of sharable, reusable makefiles for building software projects.
make
is a command-line utility for maintaining groups of software files, typically source code files. Originally created in 1976 as a software build automation tool for Unix environments, it can be used more broadly "to describe any task where files must be updated automatically from others whenever the others change". This automation is facilitated via so-called makefiles, script-like description files that declaratively specify via variable definitions and build rules:
- A software project's file components;
- The dependency graph of these components (i.e., their interrelationships);
- The sequence of commands for creating or updating each component.
Makefile projects, integrated sets of makefiles, provide a blueprint for a software project's source code base and its maintenance. In addition, together with the make
command, makefile projects serve as the scaffolding for build activities and more within a software project's development process.
The makefile project presented here, .make, defines variable definitions and build rules for popular software project platforms (Python, Swift, etc). Its makefiles are stored in a special folder, conveniently named .make
that can be stored in a user's home folder or within the software project itself.
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
.make supports 2 major operating systems:
It can indirectly support the Windows operating system if used with Microsoft's native Windows Subsystem for Linux (WSL) or a 3rd-party emulator like Git BASH (part of Git for Windows).
.make can be installed in 3 easy steps.
-
Navigate to the target folder (typically a user's home folder) to which .make will be installed.
$ cd ~
-
Clone .make within the target folder.
$ git clone https://github.com/djrlj694/.make.git
-
Complete final setup activities, such as:
- Copying the sample main makefile (
Makefile.sample
) to a renamed version (Makefile
) just above the project folder; - Removing all non-essential, leftover artifacts from cloning this project.
$ bash .make/setup.sh
- Copying the sample main makefile (
TODO: Alternatively, if Cookiecutter is installed on your local host, you can run the following command to more conveniently and flexibly install .make:
$ cookiecutter gh:djrlj694/cookiecutter-make
TODO: Using the latest API, Demo one or more examples of syntax and associated output, if any.
TODO: Describe and show how to build artifacts and run tests.
Documentation for the project is pending but eventually will be found here.
Currently, there are no known issues. If you discover any, please kindly submit a pull request.
Code and codeless (documentation, donations, etc.) contributions are welcome. To contribute yours, see CONTRIBUTING.md.
.make is released under the MIT License.
API documentation, tutorials, and other online references and made portions of this project possible. See REFERENCES.md for a list of some.