Improve the project README
- Use the SVG version of the logo.
- Mention console support in the first paragraph.
- Point contributors to the `#godotengine-devel` IRC channel.
- Improve formatting for better readability.
- Add more links when needed.
- Fix warnings reported by markdownlint.
(cherry picked from commit b0713e9e6c
)
This commit is contained in:
parent
c2d7d81ac8
commit
0429779835
54
README.md
54
README.md
|
@ -1,25 +1,29 @@
|
||||||
[![Godot Engine logo](/logo.png)](https://godotengine.org)
|
# Godot Engine
|
||||||
|
|
||||||
## Godot Engine
|
<p align="center">
|
||||||
|
<a href="https://godotengine.org">
|
||||||
|
<img src="logo.svg" width="400" alt="Godot Engine logo">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
Homepage: https://godotengine.org
|
## 2D and 3D cross-platform game engine
|
||||||
|
|
||||||
#### 2D and 3D cross-platform game engine
|
**[Godot Engine](https://godotengine.org) 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, macOS,
|
||||||
|
Windows), mobile platforms (Android, iOS), as well as Web-based platforms
|
||||||
|
(HTML5) and
|
||||||
|
[consoles](https://docs.godotengine.org/en/latest/tutorials/platform/consoles.html).
|
||||||
|
|
||||||
Godot Engine is a feature-packed, cross-platform game engine to create 2D and
|
## Free, open source and community-driven
|
||||||
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.
|
|
||||||
|
|
||||||
#### Free, open source and community-driven
|
|
||||||
|
|
||||||
Godot is completely free and open source under the very permissive MIT license.
|
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
|
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
|
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
|
community-driven, empowering users to help shape their engine to match their
|
||||||
expectations. It is supported by the Software Freedom Conservancy
|
expectations. It is supported by the [Software Freedom Conservancy](https://sfconservancy.org/)
|
||||||
not-for-profit.
|
not-for-profit.
|
||||||
|
|
||||||
Before being open sourced in February 2014, Godot had been developed by Juan
|
Before being open sourced in February 2014, Godot had been developed by Juan
|
||||||
|
@ -28,43 +32,45 @@ years as an in-house engine, used to publish several work-for-hire titles.
|
||||||
|
|
||||||
![Screenshot of a 3D scene in Godot Engine](https://raw.githubusercontent.com/godotengine/godot-design/master/screenshots/editor_tps_demo_1920x1080.jpg)
|
![Screenshot of a 3D scene in Godot Engine](https://raw.githubusercontent.com/godotengine/godot-design/master/screenshots/editor_tps_demo_1920x1080.jpg)
|
||||||
|
|
||||||
### Getting the engine
|
## Getting the engine
|
||||||
|
|
||||||
#### Binary downloads
|
### Binary downloads
|
||||||
|
|
||||||
Official binaries for the Godot editor and the export templates can be found
|
Official binaries for the Godot editor and the export templates can be found
|
||||||
[on the homepage](https://godotengine.org/download).
|
[on the homepage](https://godotengine.org/download).
|
||||||
|
|
||||||
#### Compiling from source
|
### Compiling from source
|
||||||
|
|
||||||
[See the official docs](https://docs.godotengine.org/en/latest/development/compiling/)
|
[See the official docs](https://docs.godotengine.org/en/latest/development/compiling/)
|
||||||
for compilation instructions for every supported platform.
|
for compilation instructions for every supported platform.
|
||||||
|
|
||||||
### Community and contributing
|
## Community and contributing
|
||||||
|
|
||||||
Godot is not only an engine but an ever-growing community of users and engine
|
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).
|
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
|
To get in touch with the engine developers, the best way is to join the
|
||||||
[#godotengine IRC channel](https://webchat.freenode.net/?channels=godotengine)
|
[#godotengine-devel IRC channel](https://webchat.freenode.net/?channels=godotengine-devel)
|
||||||
on Freenode.
|
on Freenode.
|
||||||
|
|
||||||
To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
|
To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
|
||||||
|
|
||||||
### Documentation and demos
|
## Documentation and demos
|
||||||
|
|
||||||
The official documentation is hosted on [ReadTheDocs](https://docs.godotengine.org).
|
The official documentation is hosted on [ReadTheDocs](https://docs.godotengine.org).
|
||||||
It is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs).
|
It is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs).
|
||||||
|
|
||||||
The [class reference](https://docs.godotengine.org/en/latest/classes/)
|
The [class reference](https://docs.godotengine.org/en/latest/classes/)
|
||||||
is also accessible from within the engine.
|
is also accessible from the Godot editor.
|
||||||
|
|
||||||
The official demos are maintained in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
|
The official demos are maintained in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
|
||||||
as well.
|
as well.
|
||||||
|
|
||||||
There are also a number of other learning resources provided by the community,
|
There are also a number of other
|
||||||
such as text and video tutorials, demos, etc. Consult the [community channels](https://godotengine.org/community)
|
[learning resources](https://docs.godotengine.org/en/latest/community/tutorials.html)
|
||||||
for more info.
|
provided by the community, such as text and video tutorials, demos, etc.
|
||||||
|
Consult the [community channels](https://godotengine.org/community)
|
||||||
|
for more information.
|
||||||
|
|
||||||
[![Actions Build Status](https://github.com/godotengine/godot/workflows/Godot/badge.svg?branch=master)](https://github.com/godotengine/godot/actions)
|
[![Actions Build Status](https://github.com/godotengine/godot/workflows/Godot/badge.svg?branch=master)](https://github.com/godotengine/godot/actions)
|
||||||
[![Code Triagers Badge](https://www.codetriage.com/godotengine/godot/badges/users.svg)](https://www.codetriage.com/godotengine/godot)
|
[![Code Triagers Badge](https://www.codetriage.com/godotengine/godot/badges/users.svg)](https://www.codetriage.com/godotengine/godot)
|
||||||
|
|
Loading…
Reference in New Issue