From 72c7da1793dad0ca82bfee755a81ca3c2e9b8a46 Mon Sep 17 00:00:00 2001 From: Jacob Vosmaer <jacob@gitlab.com> Date: Mon, 8 Aug 2016 11:00:21 +0200 Subject: [PATCH 1/2] Add extra link to howto index --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8990ec7..0192cfc 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ Configure and manage a [GitLab](https://about.gitlab.com) development environment. +Read on for installation instructions or skip to +[doc/howto](doc/howto/README.md) for usage documentation. + ## Overview GitLab Development Kit (GDK) provides a collection of scripts and @@ -12,6 +15,8 @@ multiple repositories and it requires Ruby, Go, Postgres/MySQL, Redis and more to run. GDK helps you install and configure all these different components, and start/stop them when you work on GitLab. +## Getting started + To start using GDK follow these three steps: - [Prepare your computer](doc/prepare.md) -- GitLab From b3c45378594d0bdda801bafad31bca8f59c20421 Mon Sep 17 00:00:00 2001 From: Jacob Vosmaer <jacob@gitlab.com> Date: Mon, 8 Aug 2016 11:06:38 +0200 Subject: [PATCH 2/2] Link back to README from doc/howto --- doc/howto/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/howto/README.md b/doc/howto/README.md index 92c37a1..48d7d69 100644 --- a/doc/howto/README.md +++ b/doc/howto/README.md @@ -1,5 +1,8 @@ # How to use GitLab Development Kit +See the [top level README](../../README.md#getting-started) for GDK +installation instructinos. + ## Basic - [Browse your development GitLab server](browse.md) -- GitLab