premake/README.md
2018-10-22 13:44:28 +02:00

41 lines
3.0 KiB
Markdown

# PREMAKE 5 (core)
<img src="https://github.com/premake/premake-core/wiki/linux-widget.jpeg" width="24" height="24"/> [![Build Status](https://travis-ci.org/premake/premake-core.svg?branch=master)](https://travis-ci.org/premake/premake-core)
<img src="https://github.com/premake/premake-core/wiki/windows-widget.jpeg" width="24" height="24"/> [![Build status](https://ci.appveyor.com/api/projects/status/lc9g332y2lqvel8h?svg=true)](https://ci.appveyor.com/project/PremakeOrganization/premake-core)
[![Latest release](https://img.shields.io/github/release/premake/premake-core/all.svg)]()
[![Release date of last release](https://img.shields.io/github/release-date-pre/premake/premake-core.svg)]()
[![Commits since last release](https://img.shields.io/github/commits-since/premake/premake-core/v5.0.0-alpha13.svg)]()
<img src="http://premake.github.io/premake-logo.png" width="200" height="200" />
Premake is a command line utility which reads a scripted definition of a software project and, most commonly, uses it to generate project files for toolsets like Visual Studio, Xcode, or GNU Make. Built-in and Third-Party [Modules](https://github.com/premake/premake-core/wiki/Modules) add support for even more toolsets.
Find out in detail [what Premake is](https://github.com/premake/premake-core/wiki/What-Is-Premake) and how to use it in the [wiki](https://github.com/premake/premake-core/wiki).
### Get started
* [Download Premake](http://premake.github.io/download.html)
* [Read the wiki](https://github.com/premake/premake-core/wiki) to find out how to get your project up and running with Premake.
### News and Community
* Check the official [Github project](https://github.com/premake/premake-core) for the latest developments
* For questions about using Premake and authoring project scripts, please ask on [StackOverflow, adding the #premake tag to your question](http://stackoverflow.com/questions/tagged/premake).
* For discussions about developing, customizing, or extending Premake and add-on modules, please use the [Premake Developers Google Groups forum](https://groups.google.com/forum/#!forum/premake-development).
### Report isssues
Something not working quite as expected? Do you need a feature that has not been implemented yet? Check the [issue tracker](https://github.com/premake/premake-core/issues) and add a new one if your problem is not already listed. Please try to provide a detailed description of your problem, including the steps to reproduce it.
### Contribute
Awesome! View the [contribution guidelines](https://github.com/premake/premake-core/wiki/Contribution-Guidelines) before you contribute. If you would like to contribute with a new feature or submit a bugfix, fork this repo and send a pull request. Please, make sure all the unit tests are passing before submitting and add new ones in case you introduced new features.
### Copyright & License
Copyright &copy; 2002-2016 by Jason Perkins
Distributed under the terms of the BSD License, see LICENSE.txt
The Lua language and runtime library is &copy; TeCGraf, PUC-Rio.
See their website at http://www.lua.org/