search

GSG-G9 / code-SOZAbit

0 stars 0 forks source link

README !! #25

Open Mu7ammadAbed opened 4 years ago

Mu7ammadAbed commented 4 years ago

README is the first file one should read when starting a new project. It’s a set of useful information about a project. It is the first file Github will show when someone opens your repository. It is simply the "front page" of the project, the place where everyone gets started.

I suggest this structure to use when writing README:

  1. The project name
  2. Team names.
  3. WHY (describing the purpose)
  4. WHAT (describing your site)
  5. HOW (describing the journey to completion)
  6. User journey
  7. User story
  8. Stretch goals