From 73fc37ee20c8812ad2a5b6871b77349a451f951f Mon Sep 17 00:00:00 2001 From: David Leal Date: Fri, 8 Jan 2021 12:28:35 -0600 Subject: [PATCH] Improve README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a27e1ae..6b8438f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# TravelNet +# Travelnet [![luacheck](https://github.com/mt-mods/travelnet/workflows/luacheck/badge.svg)](https://github.com/mt-mods/travelnet/actions?query=workflow%3Aluacheck) [![Integration test](https://github.com/mt-mods/travelnet/workflows/integration-test/badge.svg)](https://github.com/mt-mods/travelnet/actions?query=workflow%3Aintegration-test) [![ContentDB](https://content.minetest.net/packages/mt-mods/travelnet/shields/downloads/)](https://content.minetest.net/packages/mt-mods/travelnet/) -# How this works +## How this works - craft it by filling the right and left row with glass; place in the middle row (from top to bottom): steel, mese, steel - place the travelnet box somewhere @@ -15,24 +15,24 @@ An unconfigured travelnet box can be configured by anyone. If it is misconfigured, just dig it and place it anew. All stations that have the same network name set and are owned by the same user connect to the same network. -# Documentation +## Documentation * [API](./doc/api.md) -# Screenshots +## Screenshots -# License +## License The mod was written by me, Sokomine, and includes small contributions from other contributors. -License: GPLv3 (see file LICENSE) +License: GPLv3 (see [`LICENSE`](https://github.com/mt-mods/travelnet/blob/master/LICENSE) for more information) The models and textures as found in the textures/ and models/ folders where created by VanessaE -and are provided under the CC0 license. +and are provided under the [CC0](https://creativecommons.org/publicdomain/zero/1.0/) license. Exceptions: -* `textures/travelnet_top.png` CC BY-SA 3.0 https://github.com/minetest/minetest_game (default_steel_block.png) -* `textures/travelnet_bottom.png` CC BY-SA 3.0 https://github.com/minetest/minetest_game (default_clay.png) +* `textures/travelnet_top.png` [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) https://github.com/minetest/minetest_game (`default_steel_block.png`) +* `textures/travelnet_bottom.png` [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) https://github.com/minetest/minetest_game (`default_clay.png`)