Skip to content

Instantly share code, notes, and snippets.

@r3code

r3code/README.md

Forked from vporoshok/README.md
Last active April 20, 2021 14:07
Show Gist options
  • Save r3code/d9b649deabed931f61f28c746863936c to your computer and use it in GitHub Desktop.
Save r3code/d9b649deabed931f61f28c746863936c to your computer and use it in GitHub Desktop.
Download ZIP
Snippet of README file for RDD (Readme driven development)
Raw
README.md

project

Read about RDD here https://vporoshok.me/post/2019/10/rdd/

Travis Build Go Report Card GoDoc codecov MIT License

One-line summary

Description (what it is). Background, terms, and abstractions.

Motivation

Why I do this project?

Philosophy

Perhaps this project is a reflection of some idea or philosophy.

Usage

Common usage case of this project in a short snippet.
It shouldn't contain all the features of the project.
Short is better than full.

How it works

Architect, conceptions, dependencies. This section should be written after implementation.

Key features

List of features that may help to decide use this project.

See also

List of inspiration projects, alternatives, and analogs. Maybe some comparisons if it's important.

Roadmap

Features to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment