From 227b53ae64b07899ee3f0c56ba5e5608be73b29a Mon Sep 17 00:00:00 2001 From: shanejonas Date: Thu, 31 Jan 2019 10:25:29 -0800 Subject: [PATCH] fix: move conventions and resource up in the readme --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2c4edc45..f0f0c495 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,30 @@ There are many ways to drive development but with open source specifically, star - [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) by Tom Preson-Werner +### Conventions and Specifications + +Using conventions, documentation and specifications make it easier to: +- communicate the problem you are solving +- ease onboarding +- build and use composable tools +- promote open source contribution and engagement +- promote issue and feature discussion on github itself + +#### Resources + +- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) +- [pengwynn/flint](https://github.com/pengwynn/flint) +- [Working Backwards](https://www.allthingsdistributed.com/2006/11/working_backwards.html) +- [Literate programming](https://en.wikipedia.org/wiki/Literate_programming) +- [Hammock Driven Development](https://www.youtube.com/watch?v=f84n5oFoZBc) +- [Inversion and The Power of Avoiding Stupidity](https://fs.blog/2013/10/inversion/) + ## Getting Started To get started, [fork](https://help.github.com/articles/fork-a-repo/) or [duplicate](https://help.github.com/articles/duplicating-a-repository/) the repository. Then edit this file and delete everything above this line. --- -### Conventions and Specifications - -Using conventions and specifications make it easier to: -- build and use composable tools -- ease onboarding -- promote contribution and engagement -- promote issue and feature discussion on github itself - ### Contributing How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING](BUILDING.md) and [RELEASING](RELEASING.md) respectively. @@ -32,17 +42,8 @@ How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUT #### Docker: -Docker is used as a building block. Here are the resources needed to get started and install docker: +Docker is used as a building block in [BUILDING](BUILDING.md) and [RELEASING](RELEASING.md). Here are the resources needed to get started and install docker: - [Install Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/) - [Install Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/) -#### Resources - -- [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html) -- [pengwynn/flint](https://github.com/pengwynn/flint) -- [Working Backwards](https://www.allthingsdistributed.com/2006/11/working_backwards.html) -- [Literate programming](https://en.wikipedia.org/wiki/Literate_programming) -- [Hammock Driven Development](https://www.youtube.com/watch?v=f84n5oFoZBc) -- [Inversion and The Power of Avoiding Stupidity](https://fs.blog/2013/10/inversion/) -