From d8fe9ad16caea0b99fef5bcce0c882e29ee468fc Mon Sep 17 00:00:00 2001 From: SmallJoker <mk939@ymail.com> Date: Sat, 19 Sep 2020 14:14:31 +0200 Subject: [PATCH] Merge new documentation with technic/doc --- README.md | 62 +++++++++++++++++++++++++----- 1 files changed, 51 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index abec467..c85aecc 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,54 @@ -technic 0.4.7 +# Technic -Technic mod for Minetest 0.4.7 +[![Build status](https://github.com/minetest-mods/technic/workflows/Check%20&%20Release/badge.svg)](https://github.com/minetest-mods/technic/actions) +[![License](https://img.shields.io/badge/license-LGPLv2.0%2B-purple.svg)](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html) -Credits for contributing to the project: -Nekogloop -ShadowNinja -VanessaE -Nore/Novatux -kpoppel -And many others for ideas/inspiring +This Minetest modpack adds machinery and automation procedure content to your +world. A few notable features: -Licences: -TO-DO + * 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. + +The API documentation can be found here: [Technic API](technic/doc/api.md) + + +## 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... -- Gitblit v1.8.0