search

aternosgames / concepts

Concepts for Aternos Games
https://concepts.aternos.games/concepts/
2 stars 2 forks source link

Create basic README files for all repositories #14

Closed ghost closed 5 years ago

ghost commented 5 years ago

How would a basic README look like? Anybody got any idea?

matthi4s commented 5 years ago

The concepts already have a basic structure that we could use/copy for the README files. However, I'm not sure if it's a good idea to duplicate the content or if we should just add a link to the concept, what do you think?

Important parts that should be included in the README, but not in the concept are building/development explanation, an introduction to contributing and a mention of the LICENSE.

ghost commented 5 years ago

What I was thinking of is having a title, maybe a logo above the title, badges beneath the title, a short description what the repository is about, a link to the concept and then how to build the project. Basically development related stuff.

(optional) logo
title
badges
short description
link to concept
development related stuff
licenses
also maybe sponsors if any?
Always a footer linking to the homepage, discord and twitter account
ghost commented 5 years ago

image That's what I was thinking of a footer

vainamov commented 5 years ago

What are these green icons at the bottom? They look awful and are probably not allowed anyways.

ghost commented 5 years ago

Lol, those are social media icons linking to the Discord server and the Twitter page of the project.

ghost commented 5 years ago

Resolved by commit https://github.com/aternosgames/concepts/commit/7553bc336291d8b1c81558a396bdcdc45a7e8484