This guide will walk you through the steps to get started with our project using GitHub Desktop, including cloning the repository, setting up your project, and pushing changes. Let's dive in!
-
Install GitHub Desktop: If you haven't already, download and install GitHub Desktop from GitHub's official website.
-
Clone the Repository:
- Open GitHub Desktop.
- Click on
File
>Clone Repository
. - In the dialog box, go to the
URL
tab and enter the URL of this repository. - Choose a local path where you want to clone the repository.
- Click on
Clone
.
For a more detailed tutorial, check out this GitHub Desktop cloning guide.
-
Copy the "FINCH_Starter" Project:
- Navigate to the cloned repository folder on your computer.
- Locate the "FINCH_Starter" project folder.
- Copy the entire folder and paste it in the same directory (or a directory of your choice).
-
Rename Your Project:
- Give the copied folder a unique and descriptive name that reflects the essence of your project.
-
Open the "FINCH_Starter.sc" File:
- Inside your new project folder, find and open the "FINCH_Starter.sc" file.
- This file is the starting point where you can begin modifying the project.
-
Make Your Changes: Work on your project and save your changes.
-
Commit and Push:
- Open GitHub Desktop and it will automatically detect changes made in your project folder.
- In the GitHub Desktop interface, you'll see a list of modified files. Add a summary and description of the changes you've made.
- Commit the changes to your branch by clicking on
Commit to main
. - To upload your changes to the repository, click on
Repository
in the menu bar and selectPush
.
Note: To push changes to the main repository, you'll need access permissions. If you don't have access, please reach out in the
#adcs
channel on Slack for issues and to get added to the repo.
If you encounter any issues or need further assistance, reach out in the #adcs
channel on Slack. Happy STKing! 🚀