From 0fd2c495ba925c485e535902a8c6c6831851ed48 Mon Sep 17 00:00:00 2001 From: alan Date: Wed, 1 Nov 2023 16:09:54 -0400 Subject: [PATCH] Update git setup --- assets/credentials.png | 3 +++ assets/gitdesktop1.png | 3 +++ assets/gitdesktop2.png | 3 +++ assets/gitdesktop3.png | 3 +++ assets/gitdesktop4.png | 3 +++ assets/gitdesktop5.png | 3 +++ assets/gitdesktop6.png | 3 +++ guides/git_setup.md | 44 ++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 65 insertions(+) create mode 100644 assets/credentials.png create mode 100644 assets/gitdesktop1.png create mode 100644 assets/gitdesktop2.png create mode 100644 assets/gitdesktop3.png create mode 100644 assets/gitdesktop4.png create mode 100644 assets/gitdesktop5.png create mode 100644 assets/gitdesktop6.png diff --git a/assets/credentials.png b/assets/credentials.png new file mode 100644 index 0000000..d76edde --- /dev/null +++ b/assets/credentials.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1a095ee2d74aaa95ecaa6425028ef5014631901346188a00838c81cc40ef040 +size 33556 diff --git a/assets/gitdesktop1.png b/assets/gitdesktop1.png new file mode 100644 index 0000000..8328838 --- /dev/null +++ b/assets/gitdesktop1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16fd712fca3389ddb6d54656b877a53c546e1c91be131cf56e68d99cbcb9d50c +size 117096 diff --git a/assets/gitdesktop2.png b/assets/gitdesktop2.png new file mode 100644 index 0000000..ecf4a2e --- /dev/null +++ b/assets/gitdesktop2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a9eb62a0a70b181c428efa818eef5d7cd232042cd227ddad292f27ce22f9d2e +size 95581 diff --git a/assets/gitdesktop3.png b/assets/gitdesktop3.png new file mode 100644 index 0000000..b32b3a4 --- /dev/null +++ b/assets/gitdesktop3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6147d82c7a4032bae0d7ce03158fdce7955c391d3f9c885a453240318d97ada +size 49828 diff --git a/assets/gitdesktop4.png b/assets/gitdesktop4.png new file mode 100644 index 0000000..bd3cddf --- /dev/null +++ b/assets/gitdesktop4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:80f21135b6eaacf8ad4a4d9d66cf4de7cbb7bad6f3180918ef7d82a1862fb142 +size 52672 diff --git a/assets/gitdesktop5.png b/assets/gitdesktop5.png new file mode 100644 index 0000000..eaf4cb9 --- /dev/null +++ b/assets/gitdesktop5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec9fc28311af585647019005bd4d1200a35cc6c449007bad9f0a14ebedcb17ad +size 62683 diff --git a/assets/gitdesktop6.png b/assets/gitdesktop6.png new file mode 100644 index 0000000..d922c88 --- /dev/null +++ b/assets/gitdesktop6.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e830ae0296b501195382f0d71bf477cb658aa4f189de337faac48ca9e52c5fbe +size 21879 diff --git a/guides/git_setup.md b/guides/git_setup.md index 809b4b1..ca0c916 100644 --- a/guides/git_setup.md +++ b/guides/git_setup.md @@ -2,3 +2,47 @@ Git comes pre-installed on Linux systems, but not Windows. Thus, you'll have to install it manually. It comes in a couple flavors, my favorite being the terminal, but we'll stick to UI for now so it's easier to tell what's going on. + +### GitHub Desktop +First, download [GitHub Desktop](https://desktop.github.com/). + +Upon running it, it should ask you to sign in. Skip this step. + +![](../assets/gitdesktop1.png) + +Now, configure git using your credentials from Gitea; use your corresponding name and email as shown below. Letter-case matters. + +![](../assets/credentials.png) + +![](../assets/gitdesktop2.png) + +## Setting up a Repository +You should now get a screen that looks like this. + +![](../assets/gitdesktop3.png) + +All of our project data is stored on the "cloud" (an SD card running on a tiny computer)? +To get the files for yourself, you need to "clone" the repository. + +To do this, go to the desired repository page on Gitea, then find the HTTP URL for git. +![](../assets/cloning_geturl.png) + +Then go to the URL tab, and paste the URL into here. Choose a folder location you can easily find. **The folder should be empty.** + +![](../assets/gitdesktop4.png) + +When you're ready, hit "Clone." This will download the Unreal Engine project folder. **If the project asks you to Initialize Git LFS, do it. It's necessary for proper file storage.** + +You should now get something like this. If you want to browse the project files locally, click on "Show in Explorer." + +![](../assets/gitdesktop5.png) + +Finally, you need to also clone down the assets as well if you're working on the art team. Clone down a new repository. + +![](../assets/gitdesktop6.png) + +Repeat the same process, but instead use the `triple-aaa-games/assets` repository URL. After that, you should be good! + +# Git for Unreal Engine +**WORK IN PROGRESS.** +*You only need to perform this setup if you plan on working inside Unreal Engine.*