minetest
/
minetest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md: Improve formatting for consistency (#7472) 

* README.md: Improve formatting for consistency
master
Anand S 2018-06-22 17:30:49 +05:30 committed by Loïc Blot
parent a38ec9dd06
commit b308cb676d
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -23,7 +23,7 @@ Further documentation
- Developer wiki: http://dev.minetest.net/ - Developer wiki: http://dev.minetest.net/
- Forum: http://forum.minetest.net/ - Forum: http://forum.minetest.net/
- Github: https://github.com/minetest/minetest/ - Github: https://github.com/minetest/minetest/
- doc/ directory of source distribution - [doc/](doc/) directory of source distribution
Default controls Default controls
---------------- ----------------
@ -72,26 +72,26 @@ Paths
----- -----
Locations: Locations:
* bin - Compiled binaries * `bin` - Compiled binaries
* share - Distributed read-only data * `share` - Distributed read-only data
* user - User-created modifiable data * `user` - User-created modifiable data
Where each location is on each platform: Where each location is on each platform:
* Windows .zip / RUN_IN_PLACE source: * Windows .zip / RUN_IN_PLACE source:
* bin = bin * `bin` = `bin`
* share = . * `share` = `.`
* user = . * `user` = `.`
* Linux installed: * Linux installed:
* bin = /usr/bin * `bin` = `/usr/bin`
* share = /usr/share/minetest * `share` = `/usr/share/minetest`
* user = ~/.minetest * `user` = `~/.minetest`
* macOS: * macOS:
* bin = Contents/MacOS * `bin` = `Contents/MacOS`
* share = Contents/Resources * `share` = `Contents/Resources`
* user = Contents/User OR ~/Library/Application Support/minetest * `user` = `Contents/User OR ~/Library/Application Support/minetest`
Worlds can be found as separate folders in: user/worlds/ Worlds can be found as separate folders in: `user/worlds/`
Configuration file: Configuration file:
------------------- -------------------
@ -105,7 +105,7 @@ Configuration file:
Command-line options: Command-line options:
--------------------- ---------------------
- Use --help - Use `--help`
Compiling Compiling
--------- ---------
@ -177,15 +177,15 @@ Run it:
$ ./bin/minetest $ ./bin/minetest
- Use cmake . -LH to see all CMake options and their current state - Use `cmake . -LH` to see all CMake options and their current state
- If you want to install it system-wide (or are making a distribution package), - If you want to install it system-wide (or are making a distribution package),
you will want to use -DRUN_IN_PLACE=FALSE you will want to use `-DRUN_IN_PLACE=FALSE`
- You can build a bare server by specifying -DBUILD_SERVER=TRUE - You can build a bare server by specifying `-DBUILD_SERVER=TRUE`
- You can disable the client build by specifying -DBUILD_CLIENT=FALSE - You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`
- You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release> - You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`
- Debug build is slower, but gives much more useful output in a debugger - Debug build is slower, but gives much more useful output in a debugger
- If you build a bare server, you don't need to have Irrlicht installed. - If you build a bare server, you don't need to have Irrlicht installed.
In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source - In that case use `-DIRRLICHT_SOURCE_DIR=/the/irrlicht/source`
### CMake options ### CMake options
@ -273,7 +273,7 @@ Library specific options:
### Compiling on Windows ### Compiling on Windows
* This section is outdated. In addition to what is described here: * This section is outdated. In addition to what is described here:
* In addition to minetest, you need to download minetest_game. * In addition to minetest, you need to download [minetest_game](https://github.com/minetest/minetest_game).
* If you wish to have sound support, you need libogg, libvorbis and libopenal * If you wish to have sound support, you need libogg, libvorbis and libopenal
* You need: * You need:
@ -428,7 +428,7 @@ This is how we build Windows releases.
Version scheme Version scheme
-------------- --------------
We use major.minor.patch since 5.0.0-dev. Prior to that we used 0.major.minor. 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. numbers are set to 0.
@ -439,4 +439,4 @@ minor/trivial features considered necessary.
Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release, Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
ie: 5.0.0-dev is the development version leading to 5.0.0. ie: 5.0.0-dev is the development version leading to 5.0.0.
Prior to that we used previous_version-dev. Prior to that we used `previous_version-dev`.