Giter Club home page Giter Club logo

.make's Introduction

.make

version pre-commit Conventional Commits

An integrated set of sharable, reusable makefiles for building software projects.

Introduction

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:

  1. A software project's file components;
  2. The dependency graph of these components (i.e., their interrelationships);
  3. 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.

Getting Started

TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:

System Requirements

.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).

Installation

.make can be installed in 3 easy steps.

  1. Navigate to the target folder (typically a user's home folder) to which .make will be installed.

    $ cd ~
  2. Clone .make within the target folder.

    $ git clone https://github.com/djrlj694/.make.git
  3. Complete final setup activities, such as:

    1. Copying the sample main makefile (Makefile.sample) to a renamed version (Makefile) just above the project folder;
    2. Removing all non-essential, leftover artifacts from cloning this project.
    $ bash .make/setup.sh

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

Usage

TODO: Using the latest API, Demo one or more examples of syntax and associated output, if any.

Builds and Testing

TODO: Describe and show how to build artifacts and run tests.

Documentation

Documentation for the project is pending but eventually will be found here.

Known Issues

Currently, there are no known issues. If you discover any, please kindly submit a pull request.

Contributing

Code and codeless (documentation, donations, etc.) contributions are welcome. To contribute yours, see CONTRIBUTING.md.

License

.make is released under the MIT License.

References

API documentation, tutorials, and other online references and made portions of this project possible. See REFERENCES.md for a list of some.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.