From dd3de7a52b70e4bb0baa125872863bc4f8b6fd13 Mon Sep 17 00:00:00 2001 From: shanejonas Date: Tue, 29 Jan 2019 18:27:07 -0800 Subject: [PATCH] feature: getting started --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 180174d..9f3e014 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,28 @@ Pristine is an open source repository in its original condition. It is meant to be a starting point and a place to find resources to augment your own open source repositories. + +## Getting Started + +To get started, you will need a [fork of the repository](https://help.github.com/articles/fork-a-repo/). Then you can 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 - promote issue and feature discussion -### How to Contribute +### Contributing + +How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING](BUILDING.md) and [RELEASING](RELEASING.md) respectively. -How to create tickets and contribute outlined in [CONTRIBUTING.md](CONTRIBUTING.md) +### Requirements -### Docker: +#### Docker: Docker is used as a building block. Here are the resources you need to get started and install docker: