From 4393c66a7e975663c9b3e62e170c98af56251292 Mon Sep 17 00:00:00 2001 From: Matt Rider Date: Thu, 11 Apr 2019 18:59:55 -0300 Subject: [PATCH] Add general installation instruction --- Installation.md | 138 ++++++++++++++++++++++++------------------------ 1 file changed, 70 insertions(+), 68 deletions(-) diff --git a/Installation.md b/Installation.md index a8803ad50..ece78b81b 100644 --- a/Installation.md +++ b/Installation.md @@ -1,3 +1,73 @@ +# General Install Instructions + +The repository can be found on GitHub. [https://github.com/Human-Connection/Human-Connection](https://github.com/Human-Connection/Human-Connection) + +{% hint style="info" %} +TODO: Create documentation section for How to Start and Beginners. +{% endhint %} + +Here are some general informations about our [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962). + +### Fork the Repository + +Click on the fork button. + +![Fork screenshot](./.gitbook/assets/screenshot-forking-nitro.png) + +### Clone your new Repository + +Set the current working folder to the path in which the repository should be cloned \(copied\). + +```bash +$ cd PATH-FOR-REPO +``` + +For cloning your new repository to your local machine modify the following command to add your GitHub user name. + +{% tabs %} +{% tab title="HTTPS" %} + +```bash +$ git clone https://github.com/YOUR-GITHUB-USERNAME/Human-Connection.git +``` + +{% endtab %} + +{% tab title="SSH" %} + +```bash +$ git clone git@github.com:YOUR-GITHUB-USERNAME/Human-Connection.git +``` + +{% endtab %} +{% endtabs %} + +Change into the new folder. + +```bash +$ cd Human-Connection +``` + +Add the original Human Connection repository as `upstream`. This prepares you to synchronize your local clone with a simple pull command in the future. + +{% tabs %} +{% tab title="HTTPS" %} + +```bash +$ git remote add upstream https://github.com/Human-Connection/Human-Connection.git +``` + +{% endtab %} + +{% tab title="SSH" %} + +```bash +$ git remote add upstream git@github.com:Human-Connection/Human-Connection.git +``` + +{% endtab %} +{% endtabs %} + # Docker Installation Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier. @@ -85,74 +155,6 @@ For further informations see also our [Kubernetes documentation](kubernetes.md). # Local Installation -The repository can be found on GitHub. [https://github.com/Human-Connection/Human-Connection](https://github.com/Human-Connection/Human-Connection) - -{% hint style="info" %} -TODO: Create documentation section for How to Start and Beginners. -{% endhint %} - -Here are some general informations about our [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962). - -### Fork the Repository - -Click on the fork button. - -![Fork screenshot](./assets/screenshot-forking-nitro.png) - -### Clone your new Repository - -Set the current working folder to the path in which the repository should be cloned \(copied\). - -```bash -$ cd PATH-FOR-REPO -``` - -For cloning your new repository to your local machine modify the following command to add your GitHub user name. - -{% tabs %} -{% tab title="HTTPS" %} - -```bash -$ git clone https://github.com/YOUR-GITHUB-USERNAME/Human-Connection.git -``` - -{% endtab %} - -{% tab title="SSH" %} - -```bash -$ git clone git@github.com:YOUR-GITHUB-USERNAME/Human-Connection.git -``` - -{% endtab %} -{% endtabs %} - -Change into the new folder. - -```bash -$ cd Human-Connection -``` - -Add the original Human Connection repository as `upstream`. This prepares you to synchronize your local clone with a simple pull command in the future. - -{% tabs %} -{% tab title="HTTPS" %} - -```bash -$ git remote add upstream https://github.com/Human-Connection/Human-Connection.git -``` - -{% endtab %} - -{% tab title="SSH" %} - -```bash -$ git remote add upstream git@github.com:Human-Connection/Human-Connection.git -``` - -{% endtab %} -{% endtabs %} - ### Install the dependencies ```bash