-
Notifications
You must be signed in to change notification settings - Fork 2
Add getting started section #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
samfreund
wants to merge
13
commits into
main
Choose a base branch
from
getting-started
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
2223a66
remove kickoff countdowns
samfreund d6943dc
make contributing section prettier
samfreund f702616
flesh out getting started section
samfreund e680f70
rename stuff and add forking/cloning
samfreund b5f809a
silly aussie
samfreund d345211
remove ascope from getting started
samfreund 58b4472
complete forking and cloning section
samfreund 261a18c
add repo to glossary
samfreund f9a805c
render local video with content figure
samfreund 7fcfaec
use content figure for forking and cloning
samfreund d970816
Merge branch 'main' into getting-started
samfreund d790142
oops typo
samfreund 02971d0
vscode and code intro coming soon
samfreund File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: Forking and Cloning | ||
| description: A guide to forking and cloning a GitHub repository for your work | ||
| prev: getting-started/vscode-overview | ||
| next: false | ||
| --- | ||
|
|
||
| import ContentFigure from '../../../components/ContentFigure.astro'; | ||
|
|
||
| ## Forking | ||
| Before beginning, it's necessary to create your own fork of the exercises repository. Before doing so, you need to have followed the instructions in the "Required Tools" section. To do so, go to the [exercises repository](https://github.com/frcsoftware/exercises) and click the "Fork" button in the top right corner. This will create a copy of the repository under your own GitHub account, allowing you to make changes without affecting the original repository. | ||
|
|
||
| <ContentFigure src="/getting-started/forking-and-cloning/forking.webm" /> | ||
|
|
||
| ## Cloning | ||
| To clone the repository you just created, open VS Code. Then, copy the URL of the repository you just forked. In VS Code, open the version control sidebar (top left), and select "Clone Repository". Paste the URL of your forked repository and select a local directory where you want it to be located. This will create a local copy of the repository on your machine, allowing you to work on the exercises. | ||
|
|
||
| <ContentFigure src="/getting-started/forking-and-cloning/cloning.webm" /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: Intro to Programming | ||
| description: Coming soon! | ||
| prev: false | ||
| next: getting-started/required-tools | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| title: Required Tools for Development | ||
| description: Installing all the necessary software for completing this course and programming in FRC | ||
| prev: getting-started/intro-to-prog | ||
| next: false | ||
| --- | ||
|
|
||
| ## WPILib tools | ||
|
|
||
| The first tool that needs to be installed is the WPILib tool package. To do so, follow the | ||
| instructions linked [here](https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/wpilib-setup.html). | ||
|
|
||
| If you intend to control a physical robot, you may also need to install the game tools. Instructions can be found [here](https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/frc-game-tools.html), | ||
| but this is not necessary at this point in time. | ||
|
|
||
| ## git | ||
|
|
||
| Git can be installed using the instructions located [here](https://git-scm.com/install/). | ||
|
|
||
| ## Creating a GitHub account | ||
|
|
||
| For many of the lessons on this website, it will be necessary to have a GitHub account. One can be can be created [here](https://github.com/signup). | ||
| It's also recommended to sign up for the [GitHub student developer pack](https://education.github.com/pack), this will give you access to a variety of resources. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: VS Code Overview | ||
| description: Coming soon! | ||
| prev: getting-started/required-tools | ||
| next: getting-started/forking-and-cloning | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be useful to have instructions located on-page. I don't know about windows/linux, but the recommended install for git here is homebrew. IMO it should be command line tools / xcode tools, since those are built-into macos
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what you mean by recommended. It seems like all the options are recommended equally, homebrew just happens to be first. I don't think it really matters, and my preference is to delegate install instructions to the third party so we don't bitrot.