From f718816ceaaf34a770a07a589e6a4b42d2796fee Mon Sep 17 00:00:00 2001 From: sfan5 Date: Fri, 16 Aug 2024 16:45:33 +0200 Subject: [PATCH] Modernize readme --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b198ccc..4e40e98 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ MESECONS by Jeija and contributors Mezzee-what? ------------ + [Mesecons](https://mesecons.net/)! They're yellow, they're conductive, and they'll add a whole new dimension to Minetest's gameplay. Mesecons is a mod for [Minetest](https://www.minetest.net/) that implements a ton of items related to digital circuitry, such as wires, buttons, lights, and even programmable controllers. Among other things, there are also pistons, solar panels, pressure plates, and note blocks. @@ -20,15 +21,18 @@ Mesecons has a similar goal to Redstone in Minecraft, but works in its own way, OK, I want in. -------------- + Go get it! -[DOWNLOAD IT NOW](https://github.com/minetest-mods/mesecons/archive/master.zip) +[![ContentDB](https://content.minetest.net/packages/Jeija/mesecons/shields/downloads/)](https://content.minetest.net/packages/Jeija/mesecons/) -Now go ahead and install it like any other Minetest mod. Don't know how? Check out [the wonderful page about it](https://wiki.minetest.net/Mods) over at the official Minetest Wiki. For your convenience, here's a quick summary: +Install it directly from your client by searching it in the Online Content tab. + +**Or** if you've downloaded a ZIP file check out [this page](https://wiki.minetest.net/Mods) over at the official Minetest Wiki. For your convenience, here's a quick summary: 1. If Mesecons is still in a ZIP file, extract the folder inside to somewhere on the computer. 2. Make sure that when you open the folder, you can directly find `README.md` in the listing. If you just see another folder, move that folder up one level and delete the old one. -3. Open up the Minetest mods folder - usually `/mods/`. If you see the `minetest` or folder inside of that, that is your mod folder instead. +3. Open up the Minetest mods folder - called `mods`. 4. Copy the Mesecons folder into the mods folder. Don't like some parts of Mesecons? Open up the Mesecons folder and delete the subfolder containing the mod you don't want. If you didn't want movestones, for example, all you have to do is delete the `mesecons_movestones` folder and they will no longer be available. @@ -37,21 +41,21 @@ There are no dependencies - it will work right after installing! How do I use this thing? ------------------------ + How about a [quick overview video](https://www.youtube.com/watch?v=6kmeQj6iW5k)? -Or maybe a [comprehensive reference](http://mesecons.net/items.html) is your style? +Or maybe a [comprehensive reference](https://mesecons.net/items.html) is your style? -An overview for the very newest of new beginners? How does [this one](http://uberi.mesecons.net/projects/MeseconsBasics/index.html) look? +An overview for the very newest of new beginners? How does [this one](https://uberi.mesecons.net/projects/MeseconsBasics/index.html) look? -There is also a [wiki page](https://wiki.minetest.net/Mods/Mesecons) dedicated to this mod. - -Want to get more into building? Why not check out the [Mesecons Laboratory](http://uberi.mesecons.net/), a website dedicated to advanced Mesecons builders? +Want to get more into building? Why not check out the [Mesecons Laboratory](https://uberi.mesecons.net/), a website dedicated to advanced Mesecons builders? Want to contribute to Mesecons itself? Check out the [source code](https://github.com/minetest-mods/mesecons)! Who wrote it anyways? --------------------- -These awesome people made Mesecons possible! + +These awesome people made Mesecons possible! (as of 2016) | Contributor | Contribution | | --------------- | -------------------------------- | @@ -72,8 +76,11 @@ These awesome people made Mesecons possible! There are also a whole bunch of other people helping with everything from code to testing and feedback. Mesecons would also not be possible without their help! +Check out the [entire contributor list](https://github.com/minetest-mods/mesecons/graphs/contributors) on GitHub. + Alright, how can I use it? -------------------------- + All textures in this project are licensed under the CC-BY-SA 3.0 (Creative Commons Attribution-ShareAlike 3.0 Generic). That means you can distribute and remix them as much as you want to, under the condition that you give credit to the authors and the project, and that if you remix and release them, they must be under the same or similar license to this one.