From 138daccbea89066666ee2e8355eddd6acd5e2bc0 Mon Sep 17 00:00:00 2001
From: "@akhil.gunda" <gunda.akhil1@gmail.com>
Date: Fri, 24 Jan 2025 09:22:43 +0100
Subject: [PATCH] updated instructions on installing Git and cloning repo using
vsc
---
README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.md b/README.md
index 7d77dd8..6789bb1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,25 @@
# heatpipepy
+## Getting started with GitHub and Visual Studio Code (VS Code)
+
+To get started with testing or collaborating on code libraries which are shared on GitHub, we need to have Git installed on the PC and a GitHub account from where the code repository can be accessed. Visual Studio Code is a popular code editor that integrates Git, GitHub and all tools necessary to run or debug programs.
+
+Steps to setup the code repository locally:
+1. Download [Visual Studio Code](https://code.visualstudio.com/Download) editor.
+2. [Configure Python Path](https://medium.com/nishkoder/setting-the-python-interpreter-path-in-visual-studio-code-a-detailed-guide-2a53f9f069f1) on VS Code, this step tells the code editor which Python version installed locally should be used to run Python code.
+3. [Download Git](https://git-scm.com/downloads) application and install it.
+4. Use the [project link](https://git-ce.rwth-aachen.de/akhil.gunda/heatpipepy), to open the GitLab project on the browser.
+5. Now, this code needs to be installed on the PC. The best way to do this is to clone the repository on the local PC. To do this, go to "Code" option on the project, and copy the link "Clone with HTTPS".
+ ![alt text][def]
+6. Open VS Code and choose a directory where you wish to save the code.
+7. Open terminal on VS Code, and run the following command, after navigating to the folder you wish to save the code at:
+```
+git clone <HTTPS url of the project>
+```
+8. You will see a new folder created with the project name (heatpipepy in this case). Change directory on terminal to this new folder.
+9. You should be able to run the code on the local machine.
+
## Introduction
@@ -64,3 +83,6 @@ Which gives:
'R_total': 0.13658624248720824
}
```
+
+
+[def]: image.png
\ No newline at end of file
--
GitLab