Differences

This shows you the differences between two versions of the page.

--- newdevs:git:install [2019/06/28 17:06] – tmccanna
+++ newdevs:git:install [2023/12/13 15:03] (current) – tmccanna
@@ Line 1: / Line 1: @@
+**New Developers Working Group**
 ====== Git for Windows ======
-===== Installation and Configuration =====
+//If you are running Evergreen on an Ubuntu virtual machine, git should already be installed, but this will allow you to code on a Windows machine without a virtual machine. The git commands will be the same regardless of the environment.//
+===== Installation and Configuration =====
 ==== 1. Create an SSH Key ====
@@ Line 28: / Line 30: @@
     * Open Git Bash.
     * At the prompt, type "git version" - Git should respond with the version that is installed
-    * Set up your user name and password with these commands:
+    * Set up your user name and password with these commands: <code bash>git config --global user.name "FirstName LastName"
-<code bash>
+git config --global user.email "youremail@domain.com"</code>
-git config --global user.name "FirstName LastName"
+  - Add your key <code bash>ssh-add /path/to/your_private_key</code>
-git config --global user.email "youremail@domain.com"
+  - If the SSH key you use for this Git repo isn't located at: ~/.ssh/id_rsa then you will need the following configuration file in ~/.ssh/config: <code>
-</code>
+  Host git.evergreen-ils.org
+    IdentityFile=<LOCATION OF YOUR SSH KEY></code>
 **Navigating Within Git Bash**
@@ Line 43: / Line 46: @@
   * Use the keyboard's "up" arrow to scroll through recent commands you've used in order to use them again.
-==== 3. Choose a Text Editor ====
+==== 3. Choose a Text Editor (optional) ====
 You can use any text editor you prefer to edit code. Many Evergreen developers use Vim, which runs inside the Git Bash window. You can also use outside programs such as Visual Studio Code, Notepad, Notepad++, or any other text editor that will save flat text. You can configure Git Bash to launch your text editor from a command, or you can use the text editor outside of Git Bash. Notepad++ is used in the instructions here because it will look and act the most familiar to Windows users.
 **Notepad++**\\
-The instructions below are for installing and configuring Notepad++ so that it can be launched from within Git Bash. As noted above, Notepad++ is just one of the options available.
+The instructions below are for installing and configuring Notepad++ in the Windows environment so that it can be launched from within Git Bash. As noted above, Notepad++ is just one of the options available.
   - Download and install Notepad++ from: [[https://notepad-plus-plus.org]]
@@ Line 58: / Line 61: @@
       * On the Advanced tab, click Environment Variables
     - In the System variables section, select the Path variable and click Edit.
-    - At the end of the existing Path variable, type a semicolon and then enter the Notepad++ file path (found above).
+    - At the end of the existing Path variable, type a semicolon and then enter the Notepad++ file path (found above). (Or, if paths are shown in a list, add New entry.)
   - Verify that Git Bash recognizes the new command.
     - Open Git Bash.
@@ Line 82: / Line 85: @@
 ==== 4. Clone the Evergreen Repository ====
+//Note that these steps assume you have read-only access to origin and write access to working.//
   - Create a folder to store your repositories / branches (for example, C:\Users\yourname\EGProjects).