summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2016-11-02 23:14:39 +0100
committerRémi Verschelde <rverschelde@gmail.com>2016-11-03 19:29:31 +0100
commitab9fa604d1fc4ed1b7c32c17cf4e76cef6eb3608 (patch)
treefe5d69d9d4b352a7acb42e68fbd84e98a3c00df9 /README.md
parentcc54189911e47ef1d432521df7d976b818123b1e (diff)
Rewrite the README to be more descriptive
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 51 insertions, 15 deletions
diff --git a/README.md b/README.md
index 504a6a32a9..935170479d 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,66 @@
-![GODOT](/logo.png)
+[![GODOT](/logo.png)](https://godotengine.org)
-https://godotengine.org
+## Godot Engine
-### The Engine
+Homepage: https://godotengine.org
-Godot is a fully featured, open source, MIT licensed, game engine. It focuses on having great tools, and a visual oriented workflow that can export to PC, Mobile and Web platforms with no hassle.
-The editor, language and APIs are feature rich, yet simple to learn, allowing you to become productive in a matter of hours.
+#### 2D and 3D cross-platform game engine
-### About
+Godot Engine is a feature-packed, cross-platform game engine to create 2D and
+3D games from a unified interface. It provides a comprehensive set of common
+tools, so that users can focus on making games without having to reinvent the
+wheel. Games can be exported in one click to a number of platforms, including
+the major desktop platforms (Linux, Mac OSX, Windows) as well as mobile
+(Android, iOS) and web-based (HTML5) platforms.
-Godot has been developed by Juan Linietsky and Ariel Manzur for several years, and was born as an in-house engine, used to publish several work-for-hire titles. Godot is a member project of the [Software Freedom Conservancy](https://sfconservancy.org)
+#### Free, open source and community-driven
-### Documentation
+Godot is completely free and open source under the very permissive MIT license.
+No strings attached, no royalties, nothing. The users' games are theirs, down
+to the last line of engine code. Godot's development is fully independent and
+community-driven, empowering users to help shape their engine to match their
+expectations. It is supported by the Software Freedom Conservancy
+not-for-profit.
-Documentation is hosted on [ReadTheDocs](http://docs.godotengine.org).
+Before being open sourced in February 2014, Godot had been developed by Juan
+Linietsky and Ariel Manzur (both still maintaining the project) for several
+years as an in-house engine, used to publish several work-for-hire titles.
-### Binary Downloads, Community, etc.
+### Getting the engine
-Binary downloads, community, etc. can be found in Godot homepage:
+#### Binary downloads
-https://godotengine.org
+Official binaries for the Godot editor and the export templates can be found
+[on the homepage](https://godotengine.org/download).
-### Compiling from Source
+#### Compiling from source
-See docs for compilation instructions for every platform:
-http://docs.godotengine.org/en/latest/reference/_compiling.html
+[See the official docs](http://docs.godotengine.org/en/latest/reference/_compiling.html)
+for compilation instructions for every supported platform.
+
+### Community
+
+Godot is not only an engine but an ever-growing community of users and engine
+developers. The main community channels are listed [on the homepage](https://godotengine.org/community).
+
+To get in touch with the developers, the best way is to join the
+[#godotengine IRC channel](https://webchat.freenode.net/?channels=godotengine)
+on Freenode.
+
+### Documentation and demos
+
+The official documentation is hosted on [ReadTheDocs](http://docs.godotengine.org).
+It is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs).
+
+The [class reference](http://docs.godotengine.org/en/latest/classes/_classes.html)
+is also accessible from within the engine.
+
+The official demos are maintained in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
+as well.
+
+There are also a number of other learning resources provided by the community,
+such as text and video tutorials, demos, etc. Consult the [community channels](https://godotengine.org/community)
+for more info.
[![Build Status](https://travis-ci.org/godotengine/godot.svg?branch=master)](https://travis-ci.org/godotengine/godot)
[![Code Triagers Badge](http://www.codetriage.com/godotengine/godot/badges/users.svg)](http://www.codetriage.com/godotengine/godot)