From c06a56daff0ffef1dad3a69eb16f5411585ccb01 Mon Sep 17 00:00:00 2001 From: SmallJoker <mk939@ymail.com> Date: Wed, 16 Sep 2020 18:56:10 +0200 Subject: [PATCH] Denser documentation. 'Slay The Dragon' Part 2 --- README.md | 61 ++++++++++++++++++++++-------- 1 files changed, 45 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a518bed..2a52855 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,55 @@ -Technic -======= +# Technic [](https://github.com/minetest-mods/technic/actions) [](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html) -Credits for contributing to the project (in alphabetical order): +This Minetest modpack adds machinery and automation procedure content to your +world. A few notable features: + + * Electric circuits + * Automated material processing (ores, wood, ...) + * Extended chest functionalities + +## Dependencies + + * Minetest 5.0.0 or newer + * [Minetest Game](https://github.com/minetest/minetest_game/) + * [mesecons](https://github.com/minetest-mods/mesecons) -> signalling events + * [pipeworks](https://gitlab.com/VanessaE/pipeworks/) -> automation of item transport + * [moreores](https://github.com/minetest-mods/moreores/) -> additional ores + * [basic_materials](https://gitlab.com/VanessaE/basic_materials) -> basic craft items + * Supports [moretrees](https://gitlab.com/VanessaE/moretrees) -> rubber trees + * Consult `depends.txt` or `mod.conf` of each mod for further dependency information. + + +## FAQ + +The modpack is explained in the [Manual](manual.md) included in this repository. + +1. My technic circuit doesn't work. No power is distributed. + * Make sure you have a switching station connected. +2. My wires do not connect to the machines. + * Each machine type requires its own cable type. If you do not have a + matching circuit, consider using a "Supply Converter" for simplicity. + +For modders: There is currently no API documentation. Any help to improve this +situation is greatly welcome. Please do not hesitate to submit a Pull Request. + + +## License + +Unless otherwise stated, all components of this modpack are licensed under the +LGPLv2 or later. See also the individual mod folders for their +secondary/alternate licenses, if any. + + +### Credits + +Contributors in alphabetical order: + * kpoppel * Nekogloop * Nore/Ekdohibs * ShadowNinja * VanessaE * And many others... - -FAQ ---- - -1. My technic circuit doesn't work. No power is distrubuted. - * A: Make sure you have a switching station connected. - -License -------- - -Unless otherwise stated, all components of this modpack are licensed under the -LGPL, V2 or later. See also the individual mod folders for their -secondary/alternate licenses, if any. -- Gitblit v1.8.0