Skip to content

espositoandrea/Make-to-Batch

Repository files navigation

Makefile to Batch

License GitHub Workflow Status GitHub release (latest by date) PyPI Quality Gate Status

This is a simple tool to convert a GNU Makefile into a Windows Batch file.

Usage

Install the tool by using PyPI using the following command:

pip install make-to-batch

You can also install by downloading the source code:

cd path/to/source/
python setup.py install

The tool provides only a command, make-to-batch, that converts a Makefile in the current directory to a batch file in the same directory. The tool behaviour can be customized using some options: here is the help of the tool.

$ make-to-batch -h
usage: make-to-batch [-h] [-v] [-i INPUT] [-o OUTPUT]

Convert a Makefile to a Batch (Windows) file.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  -i INPUT, --input INPUT
                        set the makefile to be converted. Defaults to
                        './Makefile'
  -o OUTPUT, --output OUTPUT
                        set the name of the output batch file. Defaults to
                        './make.bat'

License

This tool/library is free software and is released under the MIT License. You're free to copy, modify, and redistribute this tool in any way: all I ask is some credit (just a mention is enough) and I'd love the source code with your edits back.

The choice of the license should allow you to use the tool in any context you like (either in free, open or proprietary contexts). If you should have any problem with it, I first apologize because I'm not a lawyer, then just contact me and we'll try to solve it together.

Contributing

For more information on how to contribute, read this comment and check the rules in the file CONTRIBUTING.md

In Short: What Should I Do?

The short answer is: do whatever you want. No discussion is required to expand the number of commands available in the translation: if you want to add new commands or options, just add them to the look up table and open a PR.

Any modification to the architecture or structure of the tool is also welcomed: just open a new issue and we'll discuss about it.

Is there a Roadmap?

There's not an actual structured roadmap for this tool: the main thing that needs to be done is to expand the set of recognized command.

Nonetheless, there are some enhancements I'd like to bring into this tool: I'll leave a brief list here.

  • Allow the tool to read from stdin and write to stdout (in the standard Unix fashion)
  • Enhance the documentation