diff --git a/README.md b/README.md index 49fb520..7efe20e 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ # Getting Started with Git ## Introduction -As you now know, git is a version control system. The Learn platfrom at Flatiron school has a deep integration with Git and GitHub. GitHub is an online hosting platform for that uses git. -Learn has a deep integration with Git and GitHub. We need to teach you just enough git to interact with GitHub like a real developer. While you can run python notebooks on the learn platform itself, you'll also want to be able to download material to your lcoal computer so you can work on it there. +As you now know, git is a version control system. The Learn platform at Flatiron school has a deep integration with Git and GitHub. GitHub is an online hosting platform that uses git. +Learn has a deep integration with Git and GitHub. We need to teach you just enough git to interact with GitHub like a real developer. While you can run python notebooks on the Learn platform itself, you'll also want to be able to download material to your local computer so you can work on it there. -## Objectives: +## Objectives You will be able to: @@ -27,7 +27,7 @@ Forking is the process of making a personal copy of the Learn lab on GitHub. It' ![What's a Fork](http://ironboard-curriculum-content.s3.amazonaws.com/front-end/lab-assets/git-workflow-1.png) -Afterwards, we'll then use `git clone` from a bash shell like terminal or git bash in order to copy the material from the web to our local computer. +Afterward, we'll then use `git clone` from a bash shell like terminal or git bash in order to copy the material from the web to our local computer. From there, git will allow us to continue to track and incorporate changes that we make to our work. @@ -48,29 +48,28 @@ To start: * Return to your web browser and navigate to the lesson you want to download. * Click the github icon - + You'll be redirected to the associated github repository like this. - + * **Click the fork button**, as shown above in order to create a copy to your personal account which you can edit and update. - - - After a moment of this: - + + You'll be redirected to your new personal copy of the repository: - + + ## `git clone` Now that you have your own copy (by forking), we're going to download a copy to your local computer using git clone. -* Copy the url. +* Copy the URL. * Mac: Press **cmd+L** to highlight the url bar and **cmd+c** to copy the url * Windows: Press **Ctrl+L** to highlight the url bar and **Ctrl+c** to copy the url @@ -101,6 +100,7 @@ Adding changes with the `git add` command is a way to stage any changes and get A commit is a permanent moment in time in your git history. A commit creates a new version of your code. To commit, memorize this command. `git commit -am "Your commit message"`. You are using the `git commit` command with the flags `-am`, which tell git to commit all the changes and to include a commit message. You supply the commit message in `""` directly in the command, `"Your commit message". + ## `git push` Pushing is the process of taking your local code and commits and syncing them, or uploading them, to GitHub. You're updating the GitHub remote (remotes are just fancy names for copies of the repository), generally your fork, represented by a remote named `origin`, by pushing your code to the remote. The git command to do this is simply `git push`. When you `git push` from within a git repository, it will take all the commits that you have locally and push them to the online remote. @@ -127,4 +127,6 @@ Pushing is the process of taking your local code and commits and syncing them, o ## Summary -In this lesson, we took an introductory look at git and github. First, we saw how to fork and clone repositories from learn ot your local machine. From there, we then further discussed how to add changes to git, commit them, and push them online. +In this lesson, we took an introductory look at git and github. First, we saw how to fork and clone repositories from Learn ot your local machine. From there, we then further discussed how to add changes to git, commit them, and push them online. + + diff --git a/Forked_Github_Page.png b/images/forked_github_page.png similarity index 100% rename from Forked_Github_Page.png rename to images/forked_github_page.png diff --git a/Github_Fork_Button.png b/images/github_fork_button.png similarity index 100% rename from Github_Fork_Button.png rename to images/github_fork_button.png diff --git a/Github_Forking_In_Progress.png b/images/github_forking_in_progress.png similarity index 100% rename from Github_Forking_In_Progress.png rename to images/github_forking_in_progress.png diff --git a/Learn_Github_Logo.png b/images/learn_github_logo.png similarity index 100% rename from Learn_Github_Logo.png rename to images/learn_github_logo.png diff --git a/index.ipynb b/index.ipynb index 222474e..48e0220 100644 --- a/index.ipynb +++ b/index.ipynb @@ -7,10 +7,10 @@ "# Getting Started with Git\n", "\n", "## Introduction \n", - "As you now know, git is a version control system. The Learn platfrom at Flatiron school has a deep integration with Git and GitHub. GitHub is an online hosting platform for that uses git. \n", - "Learn has a deep integration with Git and GitHub. We need to teach you just enough git to interact with GitHub like a real developer. While you can run python notebooks on the learn platform itself, you'll also want to be able to download material to your lcoal computer so you can work on it there.\n", + "As you now know, git is a version control system. The Learn platform at Flatiron school has a deep integration with Git and GitHub. GitHub is an online hosting platform that uses git. \n", + "Learn has a deep integration with Git and GitHub. We need to teach you just enough git to interact with GitHub like a real developer. While you can run python notebooks on the Learn platform itself, you'll also want to be able to download material to your local computer so you can work on it there.\n", "\n", - "## Objectives:\n", + "## Objectives\n", "\n", "You will be able to:\n", "\n", @@ -19,13 +19,9 @@ "* Use `git status` to see the status of your locally cloned git repository.\n", "* Use `git add .` to add your local changes to be committed.\n", "* Use `git commit -am \"Commit Message\"` to commit changes that have been added with a message.\n", - "* Use `git push` to upload your local changes to GitHub.\n" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "* Use `git push` to upload your local changes to GitHub.\n", + "\n", + "\n", "## Some terminology and concepts\n", "\n", "As you can see from the objectives above, we're going to dive in and use several git commands in this lesson. \n", @@ -36,7 +32,7 @@ "\n", "![What's a Fork](http://ironboard-curriculum-content.s3.amazonaws.com/front-end/lab-assets/git-workflow-1.png)\n", " \n", - "Afterwards, we'll then use `git clone` from a bash shell like terminal or git bash in order to copy the material from the web to our local computer.\n", + "Afterward, we'll then use `git clone` from a bash shell like terminal or git bash in order to copy the material from the web to our local computer.\n", "\n", "From there, git will allow us to continue to track and incorporate changes that we make to our work. \n", "\n", @@ -44,13 +40,8 @@ "\n", "If we have made changes that we would like to save to our version control history, we can then use `git add` to add the changed files to the version history and `git commit` to finalize the process. As a final process, we can then use `git push` to push our changes to the web so that we or collaborators can access them from anywhere. \n", "\n", - "Now that you have a brief overview of what we're about to dive into, let's go through the process step by step." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "Now that you have a brief overview of what we're about to dive into, let's go through the process step by step.\n", + "\n", "## Open up a Bash Shell and Create a Course Folder / Subfolder\n", "\n", "To use git, we're going back to the bash shell (mac: terminal, windows: git bash) once again!\n", @@ -62,53 +53,28 @@ "* Return to your web browser and navigate to the lesson you want to download.\n", "* Click the github icon\n", "\n", - "" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "\n", + "\n", "\n", "You'll be redirected to the associated github repository like this. \n", - "\n", + "\n", + "\n", + "* **Click the fork button**, as shown above in order to create a copy to your personal account which you can edit and update.\n", "\n", - "* **Click the fork button**, as shown above in order to create a copy to your personal account which you can edit and update." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "\n" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ "After a moment of this:\n", - "" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "\n", + "\n", + "\n", "\n", "You'll be redirected to your new personal copy of the repository:\n", - "" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "\n", + "\n", + "\n", "## `git clone`\n", "\n", "Now that you have your own copy (by forking), we're going to download a copy to your local computer using git clone.\n", "\n", - "* Copy the url. \n", + "* Copy the URL. \n", " * Mac: Press **cmd+L** to highlight the url bar and **cmd+c** to copy the url\n", " * Windows: Press **Ctrl+L** to highlight the url bar and **Ctrl+c** to copy the url\n", "\n", @@ -121,13 +87,8 @@ "The repository and all of its contents will be downloaded locally to your computer!\n", "\n", "You should be able to see the new folder by listing the files in the current directory with `ls`. \n", - "You can then navigate into the git directory with `cd directory_name`." - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "You can then navigate into the git directory with `cd directory_name`.\n", + "\n", "Now that you have a local copy, we can further investigate some more git commands for version control. **Note that for these to work you must be in the git folder (the one we just cloned above). Make sure to navigate into the folder using the `cd` command.**\n", "\n", "## `git status`\n", @@ -144,15 +105,12 @@ "\n", "A commit is a permanent moment in time in your git history. A commit creates a new version of your code. To commit, memorize this command. `git commit -am \"Your commit message\"`. You are using the `git commit` command with the flags `-am`, which tell git to commit all the changes and to include a commit message. You supply the commit message in `\"\"` directly in the command, `\"Your commit message\".\n", "\n", + "\n", "## `git push`\n", "\n", - "Pushing is the process of taking your local code and commits and syncing them, or uploading them, to GitHub. You're updating the GitHub remote (remotes are just fancy names for copies of the repository), generally your fork, represented by a remote named `origin`, by pushing your code to the remote. The git command to do this is simply `git push`. When you `git push` from within a git repository, it will take all the commits that you have locally and push them to the online remote.\n" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ + "Pushing is the process of taking your local code and commits and syncing them, or uploading them, to GitHub. You're updating the GitHub remote (remotes are just fancy names for copies of the repository), generally your fork, represented by a remote named `origin`, by pushing your code to the remote. The git command to do this is simply `git push`. When you `git push` from within a git repository, it will take all the commits that you have locally and push them to the online remote.\n", + "\n", + "\n", "## Additional Resources\n", "\n", "[GIT Cheatsheet](http://www.git-tower.com/blog/content/posts/54-git-cheat-sheet/git-cheat-sheet-large01.png)\n", @@ -174,7 +132,8 @@ "\n", "## Summary\n", "\n", - "In this lesson, we took an introductory look at git and github. First, we saw how to fork and clone repositories from learn ot your local machine. From there, we then further discussed how to add changes to git, commit them, and push them online." + "In this lesson, we took an introductory look at git and github. First, we saw how to fork and clone repositories from Learn ot your local machine. From there, we then further discussed how to add changes to git, commit them, and push them online.\n", + "\n" ] } ], @@ -194,7 +153,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.6.5" + "version": "3.6.4" } }, "nbformat": 4,