mirror of
https://github.com/luanti-org/luanti.git
synced 2025-10-23 04:45:24 +02:00
Refactor README.md
This commit is contained in:
81
README.md
81
README.md
@@ -1,5 +1,4 @@
|
||||
Minetest
|
||||
========
|
||||
# Minetest
|
||||
|
||||

|
||||
[](https://hosted.weblate.org/engage/minetest/?utm_source=widget)
|
||||
@@ -10,30 +9,17 @@ Minetest is a free open-source voxel game engine with easy modding and game crea
|
||||
Copyright (C) 2010-2022 Perttu Ahola <celeron55@gmail.com>
|
||||
and contributors (see source file comments and the version control log)
|
||||
|
||||
Table of Contents
|
||||
------------------
|
||||
## Further Documentation
|
||||
|
||||
1. [Further Documentation](#further-documentation)
|
||||
2. [Default Controls](#default-controls)
|
||||
3. [Paths](#paths)
|
||||
4. [Configuration File](#configuration-file)
|
||||
5. [Command-line Options](#command-line-options)
|
||||
6. [Compiling](#compiling)
|
||||
7. [Docker](#docker)
|
||||
8. [Version Scheme](#version-scheme)
|
||||
* Website: https://minetest.net/
|
||||
* Wiki: https://wiki.minetest.net/
|
||||
* Developer wiki: https://dev.minetest.net/
|
||||
* Forum: https://forum.minetest.net/
|
||||
* GitHub: https://github.com/minetest/minetest/
|
||||
* [doc/](doc/) directory of source distribution
|
||||
|
||||
## Default Controls
|
||||
|
||||
Further documentation
|
||||
----------------------
|
||||
- Website: https://www.minetest.net/
|
||||
- Wiki: https://wiki.minetest.net/
|
||||
- Forum: https://forum.minetest.net/
|
||||
- GitHub: https://github.com/minetest/minetest/
|
||||
- [Developer documentation](doc/developing/)
|
||||
- [doc/](doc/) directory of source distribution
|
||||
|
||||
Default controls
|
||||
----------------
|
||||
All controls are re-bindable using settings.
|
||||
Some can be changed in the key config dialog in the settings tab.
|
||||
|
||||
@@ -73,8 +59,8 @@ Some can be changed in the key config dialog in the settings tab.
|
||||
| F10 | Show/hide console |
|
||||
| F12 | Take screenshot |
|
||||
|
||||
Paths
|
||||
-----
|
||||
## Paths
|
||||
|
||||
Locations:
|
||||
|
||||
* `bin` - Compiled binaries
|
||||
@@ -100,46 +86,41 @@ Where each location is on each platform:
|
||||
* `share` = `Contents/Resources`
|
||||
* `user` = `Contents/User` or `~/Library/Application Support/minetest` or `$MINETEST_USER_PATH`
|
||||
|
||||
Worlds can be found as separate folders in: `user/worlds/`
|
||||
Worlds can be found as separate folders in `user/worlds/`
|
||||
|
||||
Configuration file
|
||||
------------------
|
||||
- Default location:
|
||||
`user/minetest.conf`
|
||||
- This file is created by closing Minetest for the first time.
|
||||
- A specific file can be specified on the command line:
|
||||
`--config <path-to-file>`
|
||||
- A run-in-place build will look for the configuration file in
|
||||
## Configuration File
|
||||
|
||||
* Default location: `user/minetest.conf`
|
||||
* This file is created by closing Minetest for the first time.
|
||||
* A specific file can be specified on the command line: `--config <path-to-file>`
|
||||
* A run-in-place build will look for the configuration file in
|
||||
`location_of_exe/../minetest.conf` and also `location_of_exe/../../minetest.conf`
|
||||
|
||||
Command-line options
|
||||
--------------------
|
||||
- Use `--help`
|
||||
## Command-Line Options
|
||||
|
||||
Compiling
|
||||
---------
|
||||
Use `--help`
|
||||
|
||||
- [Compiling on GNU/Linux](doc/compiling/linux.md)
|
||||
- [Compiling on Windows](doc/compiling/windows.md)
|
||||
- [Compiling on MacOS](doc/compiling/macos.md)
|
||||
## Compiling
|
||||
|
||||
Docker
|
||||
------
|
||||
* [Compiling on GNU/Linux](doc/compiling/linux.md)
|
||||
* [Compiling on Windows](doc/compiling/windows.md)
|
||||
* [Compiling on MacOS](doc/compiling/macos.md)
|
||||
|
||||
- [Developing minetestserver with Docker](doc/developing/docker.md)
|
||||
## Docker
|
||||
|
||||
* [Developing minetestserver with Docker](doc/developing/docker.md)
|
||||
|
||||
We provide a Dockerfile that can be used to build the server.
|
||||
|
||||
## Version Scheme
|
||||
|
||||
Version scheme
|
||||
--------------
|
||||
We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
|
||||
|
||||
- Major is incremented when the release contains breaking changes, all other
|
||||
* Major is incremented when the release contains breaking changes, all other
|
||||
numbers are set to 0.
|
||||
- Minor is incremented when the release contains new non-breaking features,
|
||||
* Minor is incremented when the release contains new non-breaking features,
|
||||
patch is set to 0.
|
||||
- Patch is incremented when the release only contains bugfixes and very
|
||||
* Patch is incremented when the release only contains bugfixes and very
|
||||
minor/trivial features considered necessary.
|
||||
|
||||
Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
|
||||
|
Reference in New Issue
Block a user