Skip to content
This repository has been archived by the owner on Sep 23, 2020. It is now read-only.

Write the readme #1

Open
fer-rum opened this issue Jan 21, 2015 · 1 comment
Open

Write the readme #1

fer-rum opened this issue Jan 21, 2015 · 1 comment

Comments

@fer-rum
Copy link

fer-rum commented Jan 21, 2015

A "Readme" file is the essence of a project - most often its first interface to the outside world.
Therefore such a file should contain at least an overview over

  • what the project does
  • who develops it
  • where to find additional information

Links are also nice.

@HirokiKibori
Copy link

A style-guide and architecture-policies are also important for contributions. (A fourth section.)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants