Readme overhaul
This commit is contained in:
parent
2706449670
commit
1de349d34f
44
README.md
44
README.md
@ -1,16 +1,38 @@
|
||||
PREMAKE
|
||||
<a href="https://travis-ci.org/premake/premake-core"><img src="https://travis-ci.org/premake/premake-core.svg?branch=master" /></a>
|
||||
# PREMAKE 5 (core) <a href="https://travis-ci.org/premake/premake-core"><img src="https://travis-ci.org/premake/premake-core.svg?branch=master" title="Build Status" alt="Build Status"/></a>
|
||||
<img src="http://premake.github.io/premake-logo.png" width="200" height="200" />
|
||||
|
||||
A build configuration tool
|
||||
Core module
|
||||
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.
|
||||
|
||||
Copyright (C) 2002-2015 by Jason Perkins
|
||||
Distributed under the terms of the BSD License, see LICENSE.txt
|
||||
|
||||
The Lua language and runtime library is (C) TeCGraf, PUC-Rio.
|
||||
See their website at http://www.lua.org/
|
||||
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).
|
||||
|
||||
See the file BUILD.txt for instructions on building Premake.
|
||||
|
||||
For questions, comments, or more information, visit the project
|
||||
website at https://github.com/premake/premake-core
|
||||
|
||||
### 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
|
||||
* Check the official [Google Group](https://groups.google.com/forum/m/#!forum/premake-development) if you need help.
|
||||
|
||||
### 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! 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](https://github.com/premake/premake-core/tree/master/tests) are passing before submitting and add new ones in case you introduced new features.
|
||||
|
||||
See the file BUILD.txt for instructions on building Premake.
|
||||
|
||||
### Copyright & License
|
||||
|
||||
Copyright © 2002-2015 by Jason Perkins
|
||||
Distributed under the terms of the BSD License, see LICENSE.txt
|
||||
|
||||
The Lua language and runtime library is © TeCGraf, PUC-Rio.
|
||||
See their website at http://www.lua.org/
|
Loading…
Reference in New Issue
Block a user