36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
|
<h1 align=center>mage</h1>
|
||
|
|
<p align="center"><img src="https://user-images.githubusercontent.com/3185864/31061203-6f6743dc-a6ec-11e7-9469-b8d667d9bc3f.png"/></p>
|
||
|
|
|
||
|
|
<p align="center">Mage is a make/rake-like build tool using Go.</p>
|
||
|
|
|
||
|
|
[](https://travis-ci.org/magefile/mage)
|
||
|
|
|
||
|
|
## Demo
|
||
|
|
|
||
|
|
[](https://www.youtube.com/watch?v=GOqbD0lF-iA)
|
||
|
|
|
||
|
|
## Discussion
|
||
|
|
|
||
|
|
Join the `#mage` channel on [gophers slack](https://gophers.slack.com/messages/general/) for discussion of usage, development, etc.
|
||
|
|
|
||
|
|
# Documentation
|
||
|
|
|
||
|
|
see [magefile.org](https://magefile.org) for full docs
|
||
|
|
|
||
|
|
see [godoc.org/github.com/magefile/mage/mage](https://godoc.org/github.com/magefile/mage/mage) for how to use mage as a library.
|
||
|
|
|
||
|
|
# Why?
|
||
|
|
|
||
|
|
Makefiles are hard to read and hard to write. Mostly because makefiles are essentially fancy bash scripts with significant white space and additional make-related syntax.
|
||
|
|
|
||
|
|
Mage lets you have multiple magefiles, name your magefiles whatever you
|
||
|
|
want, and they're easy to customize for multiple operating systems. Mage has no
|
||
|
|
dependencies (aside from go) and runs just fine on all major operating systems, whereas make generally uses bash which is not well supported on Windows.
|
||
|
|
Go is superior to bash for any non-trivial task involving branching, looping, anything that's not just straight line execution of commands. And if your project is written in Go, why introduce another
|
||
|
|
language as idiosyncratic as bash? Why not use the language your contributors
|
||
|
|
are already comfortable with?
|
||
|
|
|
||
|
|
# TODO
|
||
|
|
|
||
|
|
* File conversion tasks
|