From 1de349d34f98e87c0c9ec66e1d3ba5f401784eca Mon Sep 17 00:00:00 2001 From: Lusito Date: Tue, 28 Jul 2015 22:18:28 +0200 Subject: [PATCH] Readme overhaul --- README.md | 44 +++++++++++++++++++++++++++++++++----------- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7dce6f96..662a653f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,38 @@ -PREMAKE - +# PREMAKE 5 (core) Build Status + -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/ \ No newline at end of file