Improve README formatting

master
poikilos 2019-07-02 16:15:33 -04:00
parent 2f61da0cb0
commit 3d13ac533c
1 changed files with 9 additions and 4 deletions

View File

@ -1,6 +1,9 @@
# Minetest Game mod: birthstones
(Based on birthstones Minetest mod by Doc22; textures based on CC-BY-SA work by various authors--
see LICENSE for full credits)
# birthstones
(minetest mod)
* Code is based on birthstones Minetest mod by Doc22.
* Default (pixel art) textures are based on CC-BY-SA work by various
authors (see LICENSE for full credits).
## Primary differences from original
(see also CHANGELOG.md)
@ -10,7 +13,7 @@ see LICENSE for full credits)
* Make changes to code to make use of modern Minetest (such as ore drop
string).
* Make 3D prerendered textures of gem (item) and mineral (and optional
block textures)
block textures); improve other textures.
### Notable Issues Found in Original
(see also exclamation points in **CHANGELOG.md**)
@ -27,6 +30,7 @@ I made some major changes to make the mod easier to maintain:
names (adding aliases for backward compatibility).
* Componentize into separate Lua files by operation.
## Known Issues
* Improve remaining block textures
* Make a trm for treasurer (separate mod)
@ -167,6 +171,7 @@ To make a Gem:
(Tutorial)](https://www.youtube.com/watch?v=I4PmptWMA08&t=8s)
by toki FX
## Minetest 2017 API notes
(see <http://wiki.minetest.net/Groups> and
<https://github.com/minetest/minetest/blob/142e2d3b74ad886eed83b0fc9d6cfea100dae10a/doc/lua_api.txt#L736>)