Fix the README - Githubissues

foundersandcoders / nazareth-recipes

An open source, co-operatively produced hub for communal Founders & Coders recipes

GNU General Public License v3.0

61 stars 0 forks source link

Fix the README #44

Open matthewdking opened 6 years ago

matthewdking commented 6 years ago

As part of improving the repo it has been raised that the README is in dire need of improvement. Maybe we should comment here on the things that need to be added to the README.

shiryz commented 6 years ago

I would edit the description, add a photo of one of the meals and delete the the links as they are now, add them in the description as links, ("You'd find meals in the recipes folder ranging from mains, breakfast, dessert etc"), it wouldn't be as readable when we have more recipes.

m4v15 commented 6 years ago

Hmmm while I agree with you to an extent @shiryz I would say I quite like the layout as it is, a kind of contents page, and is better and easier to use effectively as a user coming across the repo. Maybe there will be an issue with scalability in the future but I think anything under 30 recipes will still be very readable and I think provides a better UX than having to click through to find a list of recipes.

finnhodgkin commented 6 years ago

I think a combination of the two could be nice :+1:.

A simple contents section with links to all the recipes and a bunch of photos plus some general information about the aims of Nazareth Recipes.

matthewdking commented 6 years ago

Links to the contributing guide and vision statement (#47) when it is created should also be included

mattlub commented 6 years ago

My vote would be to keep it simple, just a brief introduction and then the recipes.

My key principles:

a welcoming, succinct, collaboration-encouraging intro
recipes are easily and immediately accessible

If others wanted a longer/more in depth intro section, I would campaign for a contents section so the actual recipes can still be found immediately.

m4v15 commented 6 years ago

These are the only photo's I have

shiryz commented 6 years ago

@m4v15 @mattlub @matthewdking @finnhodgkin @Karyum , hope I didn't miss any of you. I have an idea for the menu on the readme (inspired by Finn): Have only the latest meal of each and the folders can be links as well, so if the last breakfast merged was omelette then we'll only have omelette in the breakfast section. that way it looks like menu of the day and we wouldn't have too many recipes in there. Every pr should also update the readme with the link to the meal

Karyum commented 6 years ago

@m4v15 what the hell is that photo mate :laughing: don't put that on the README

Karyum commented 6 years ago

Creamy README :laughing: