Skip to content

Slugbotics/SoftwareOnboarding2025

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

0.1. Table of Contents

1. SoftwareOnboarding2025

1.1. Git and Github setup

Setup Process

Windows

install git

Mac

Open terminal, paste this command and press enter to install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then use brew to install git
brew install git

Linux

here's an example for Ubuntu, other distros will be similar but with a different package manager
sudo apt update
sudo apt upgrade
sudo apt install git

Basic Git Commands

To clone a repo onto your device:

git clone https://github.com/{USERNAME}/{REPO_NAME}

Following this clone, you can now access the directory using: cd {REPO_NAME}

To update local files:

git pull

To update the Git repository to match local files:

git add .
git commit -m "{Commit Message}"
git push

1.2. Navigating the Command Line

Mac and Linux

To move through directories:

cd {directory_name}

To move backwards through directories:

cd ..

To make a new file:

touch {filename.txt}

To make a new directory:

mkdir {directory_name}

To delete a file:

rm {file_name}

To delete a directory (and contents):

rm -rf {directory_name}

To view a file without accessing:

cat {file_name}

To view current directory:

ls

or

ls {path/to/directory/directory_name}
Windows

To move through directories:

cd {directory_name}

To move backwards through directories:

cd ..

To make a new file:

echo. > {filename.txt}

To make a new directory:

mkdir {directory_name}

To delete a file:

del {file_name}

To force delete a directory(and contents):

rmdir /S /Q {directory_name}

To view a file without accessing:

type {file_name}

To view current directory:

dir

or

dir {path/to/directory/directory_name}
Windows Powershell

To move through directories:

cd {directory_name}

To move backwards through directories:

cd ..

To make a new file:

New-Item {filename.txt}

To make a new directory:

New-Item -ItemType Directory {directory_name}

To delete a file:

Remove-Item {file_name}

To force delete a directory(and contents):

Remove-Item {directory_name} -Recurse -Force

To view a file without accessing:

Get-Content {file_name}

To view current directory:

Get-ChildItem

1.3. Github CLI

Instead of using SSH keys, we recommend authentication using github CLI ('gh')

Step 1: Install Github CLI

Windows Download the GitHub CLI installer from [here](https://cli.github.com/). Alternatively, install via **winget**: ```bash winget install --id GitHub.cli ```
Mac Install using homebrew: ```bash brew install gh ```
Linux ```bash sudo apt install gh ```

Step 2: Authenticate Github

gh auth login

You will be guided through the following:

  1. Select Github.com
  2. Select HTTPS as preferred protocol
  3. When asked, click "Login with a web broswer"
  4. Follow on screen instructions to copy and paste a one time code
  5. Test your connection with:
gh auth status

Step 3: Using Github ClI

Github CLI gives you access to useful commands, such as gh repo clone owner/repo-name gh issue list gh pr create gh repo view


1.4. Vscode Setup

Windows and Mac

install vscode

Linux

here's an example for Ubuntu, other distros will be similar but with a different package manager
sudo snap install --classic code

1.5. Install Python

Windows

install python when it prompts you, select "Add to PATH"

Mac

brew install python

Linux

sudo apt install python3 sudo apt install python3-pip

venv setup: in order to use pip packages you need to set up a venv (virtual environment)

go to your terminal (git bash for windows, terminal for everyone else)

and type python3 -m venv ~/.rover source ~/.rover/bin/activate

1.6 Rover Team Interest Survey

Please fill out this form to gain your specific discord roles

QR Code QR Code

About

A setup guide for all the basic things needed to code for Slugbotics such as git, github, and vscode

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8