Skip to content

Commit b308cb6

Browse files
ClobberXDnerzhul
authored andcommittedJun 22, 2018
README.md: Improve formatting for consistency (#7472)
* README.md: Improve formatting for consistency
1 parent a38ec9d commit b308cb6

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed
 

Diff for: ‎README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Further documentation
2323
- Developer wiki: http://dev.minetest.net/
2424
- Forum: http://forum.minetest.net/
2525
- Github: https://github.com/minetest/minetest/
26-
- doc/ directory of source distribution
26+
- [doc/](doc/) directory of source distribution
2727

2828
Default controls
2929
----------------
@@ -72,26 +72,26 @@ Paths
7272
-----
7373
Locations:
7474

75-
* bin - Compiled binaries
76-
* share - Distributed read-only data
77-
* user - User-created modifiable data
75+
* `bin` - Compiled binaries
76+
* `share` - Distributed read-only data
77+
* `user` - User-created modifiable data
7878

7979
Where each location is on each platform:
8080

8181
* Windows .zip / RUN_IN_PLACE source:
82-
* bin = bin
83-
* share = .
84-
* user = .
82+
* `bin` = `bin`
83+
* `share` = `.`
84+
* `user` = `.`
8585
* Linux installed:
86-
* bin = /usr/bin
87-
* share = /usr/share/minetest
88-
* user = ~/.minetest
86+
* `bin` = `/usr/bin`
87+
* `share` = `/usr/share/minetest`
88+
* `user` = `~/.minetest`
8989
* macOS:
90-
* bin = Contents/MacOS
91-
* share = Contents/Resources
92-
* user = Contents/User OR ~/Library/Application Support/minetest
90+
* `bin` = `Contents/MacOS`
91+
* `share` = `Contents/Resources`
92+
* `user` = `Contents/User OR ~/Library/Application Support/minetest`
9393

94-
Worlds can be found as separate folders in: user/worlds/
94+
Worlds can be found as separate folders in: `user/worlds/`
9595

9696
Configuration file:
9797
-------------------
@@ -105,7 +105,7 @@ Configuration file:
105105

106106
Command-line options:
107107
---------------------
108-
- Use --help
108+
- Use `--help`
109109

110110
Compiling
111111
---------
@@ -177,15 +177,15 @@ Run it:
177177

178178
$ ./bin/minetest
179179

180-
- Use cmake . -LH to see all CMake options and their current state
180+
- Use `cmake . -LH` to see all CMake options and their current state
181181
- If you want to install it system-wide (or are making a distribution package),
182-
you will want to use -DRUN_IN_PLACE=FALSE
183-
- You can build a bare server by specifying -DBUILD_SERVER=TRUE
184-
- You can disable the client build by specifying -DBUILD_CLIENT=FALSE
185-
- You can select between Release and Debug build by -DCMAKE_BUILD_TYPE=<Debug or Release>
182+
you will want to use `-DRUN_IN_PLACE=FALSE`
183+
- You can build a bare server by specifying `-DBUILD_SERVER=TRUE`
184+
- You can disable the client build by specifying `-DBUILD_CLIENT=FALSE`
185+
- You can select between Release and Debug build by `-DCMAKE_BUILD_TYPE=<Debug or Release>`
186186
- Debug build is slower, but gives much more useful output in a debugger
187187
- If you build a bare server, you don't need to have Irrlicht installed.
188-
In that case use -DIRRLICHT_SOURCE_DIR=/the/irrlicht/source
188+
- In that case use `-DIRRLICHT_SOURCE_DIR=/the/irrlicht/source`
189189

190190
### CMake options
191191

@@ -273,7 +273,7 @@ Library specific options:
273273
### Compiling on Windows
274274

275275
* This section is outdated. In addition to what is described here:
276-
* In addition to minetest, you need to download minetest_game.
276+
* In addition to minetest, you need to download [minetest_game](https://github.com/minetest/minetest_game).
277277
* If you wish to have sound support, you need libogg, libvorbis and libopenal
278278

279279
* You need:
@@ -428,7 +428,7 @@ This is how we build Windows releases.
428428

429429
Version scheme
430430
--------------
431-
We use major.minor.patch since 5.0.0-dev. Prior to that we used 0.major.minor.
431+
We use `major.minor.patch` since 5.0.0-dev. Prior to that we used `0.major.minor`.
432432

433433
- Major is incremented when the release contains breaking changes, all other
434434
numbers are set to 0.
@@ -439,4 +439,4 @@ minor/trivial features considered necessary.
439439

440440
Since 5.0.0-dev and 0.4.17-dev, the dev notation refers to the next release,
441441
ie: 5.0.0-dev is the development version leading to 5.0.0.
442-
Prior to that we used previous_version-dev.
442+
Prior to that we used `previous_version-dev`.

0 commit comments

Comments
 (0)
Please sign in to comment.