Reorganize the README and make the version compatibility notice clearer

This commit is contained in:
Hugo Locurcio
2018-03-26 18:44:50 +02:00
parent af5d7a1598
commit 5f65fcbca1

View File

@@ -4,15 +4,21 @@ Each folder containing an `engine.cfg` file is a demo project meant to
be used with [Godot Engine](https://godotengine.org), the open source
2D and 3D game engine.
Those demos are distributed under the terms of the MIT license, as
described in the [LICENSE.md](LICENSE.md) file.
## Important note
**Note:**
Master branch is compatible with the latest Godot version (currently 3.0). Use the appropriate branch for your Godot version, for example branch [2.1](https://github.com/godotengine/godot-demo-projects/tree/2.1) for Godot 2.1.x.
- The `master` branch is compatible with the latest Godot version (currently 3.0).
- Use the appropriate branch for your Godot version, such as the
[`2.1`](https://github.com/godotengine/godot-demo-projects/tree/2.1) branch
for Godot 2.1.x.
### Useful links
## Useful links
- [Main website](https://godotengine.org)
- [Source code](https://github.com/godotengine/godot)
- [Documentation](http://docs.godotengine.org)
- [Community hub](https://godotengine.org/community)
## License
Those demos are distributed under the terms of the MIT license, as
described in the [LICENSE.md](LICENSE.md) file.