https://github.com/joshi4/rmake

rmake finds makefiles so you don't have to
https://github.com/joshi4/rmake

builds go golang make makefile recursive rmake

Last synced: 2 months ago
JSON representation

rmake finds makefiles so you don't have to

• Host: GitHub
• URL: https://github.com/joshi4/rmake
• Owner: joshi4
• License: mit
• Created: 2018-01-05T22:24:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-24T05:15:27.000Z (over 5 years ago)
• Last Synced: 2024-05-13T00:42:33.221Z (5 months ago)
• Topics: builds, go, golang, make, makefile, recursive, rmake
• Language: Go
• Homepage:
• Size: 1.85 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - rmake

README

        
# rmake

## Usage

`rmake` is a wrapper around make written in Go.

`rmake` invokes make with any arguments that it was passed.

`rmake` looks for a Makefile in the current working directory, if none is found it moves up to the parent directory.

This process is repeated till a Makefile is found or till the user's home directory is reached at which point `rmake` will make a best effort call to make from the original directory in which `rmake` was called

## Install

Install `rmake` by running the following command in your shell.

~~~sh

go get github.com/joshi4/rmake

~~~

To install `go` and setup the work environment see [this link](https://golang.org/doc/install#install).

**NOTE:** Make sure you've set the `GOPATH` variable correctly :)

## Motivation

The most common mistake I make while using make ( no pun intended ) is to invoke the command from a child directory where no Makefile  is present.

I estimate I run `make` about 50 - 100 times a day and hit the above error about 90% of the time. This tool is my attempt to solve this pain point.

### Alternatives

make provides a -C flag which accepts the path to the make file but that defeats the purpose as it is more effort/time consuming to type it out.

Using your bash history reduces the pain of repeating the -C flag, however, that fails when you have to switch amongst different repos/makefiles quite frequently.

Infact, using `rmake` will make it possible to use your bash history more consistently as `rmake test` or `rmake build` are common enough and the -C flag is abstracted away

## Testing

We have a simple end to end test for rmake in CI. Please see the `.travis.yml` file