Useless README's

[Baggypants]

I've got a gripe with some of the mod README's

For instance, I';ve been playing carbone. I have a small private server for me and my lad and I thought I'd checkout the protection mod. By now I know the drill, look in the mods folder. find a subfolder that looks like it might do the job, check the README which will be rubbish and then check in the init.lua.

The readme in question by the way

minetest-protect
================

Protector mod for minetest
based on glomie's mod, remade by Zeg9 and reworked by TenPlus1 to support minetest 0.4.9

Thanks a bunch.

The next step after reading the code is to search the forum to try and find the mod in question. Then I suppose if by some chance it's hosted on git (TenPlus1 doesn't tend to if I remember correctly) edit the README and submit a patch

[TenPlus1]

Incase you are wondering I'm just getting use to using github after setting up an account not so long ago and trying to keep things updated and in working order with the new 0.4.11 release as well as my normal job... When I have time things do tend to get updated and I will add a link to the forum page in my github readme's so players know what each mod does with some instructions...

[Baggypants]

Fabbo!

[Sokomine]

I'm afraid most of my README.md are even shorter and less informative. In most cases, linking the forum thread might be best, as that is where the documentation happens.

[rubenwardy]

The readme is used because it supplies a description on the GitHub website. I usually try to make mine descriptive, but I often fail. I'll go through and check mine.

[afflatus]

What DO you want to find in a README?
At the moment I mostly use them for texture credits.
Are you expecting install instructions, crafting recipes?
If we could come up with some unambiguous guidelines, perhaps this could be added to an FAQ / doc somwhere?

[Napiophelios]

What DO you want to find in a README?
At the moment I mostly use them for texture credits.
Are you expecting install instructions, crafting recipes?
If we could come up with some unambiguous guidelines, perhaps this could be added to an FAQ / doc somwhere?

Here is a pretty frikkin good example :)

[afflatus]

Nice to know someone is paying attention. ;-)

[Napiophelios]

Nice to know someone is paying attention. ;-)

My hat goes off to anyone who can incorporate a Joseph Campbell quote
into a read me for a Minetest game

[Baggypants]

What DO you want to find in a README?
At the moment I mostly use them for texture credits.
Are you expecting install instructions, crafting recipes?
If we could come up with some unambiguous guidelines, perhaps this could be added to an FAQ / doc somwhere?

Here is a pretty frikkin good example :)

They are all excelent suggestions. At the very least, I'd like a link to somewhere that gives a clue about the crafting guide. (assuming it's a crafting mod). As much as I like doing

grep -A 9 -r '_craft' *.lua

it's a bit beyond my son.

A line about what the mod provides to the engine would be nice too. 'protector mod for minetest' gives me three pieces of information I know 'mod for minetest' and one which is ambiguous.

[afflatus]

My hat goes off to anyone who can incorporate a Joseph Campbell quote
into a read me for a Minetest game

Thanks. :-)
You have the dubious distinction of being the first person ever to give me feedback on this project.
As I haven't announced any releases yet, I wasn't really expecting any. ;-)

[pepprim]

I think it is an interesting thread, I'm serious. But I don't understand... Why is it on the servers forum? Shouldn't be it on the modding discussion subforum?

[Baggypants]

Good point, I thought this was in General Discussion. Mods, please move!