Skip to content

Commit 83650a1

Browse files
author
Scott Campit
authored
Update README.md
1 parent 81d3c8b commit 83650a1

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
# Introduction to GitHub
1+
# Using Git and GitHub for research and software development
22
Author: Scott Campit
33

4-
### Why another GitHub tutorial?
5-
Hi there.
4+
### Why use Git and GitHub?
5+
So you've been working on some cool visualization pipeline or new machine learning algorithm that can help a bunch of people in lab, is necessary for a programming project, or is the software package you're publishing. You can send the source code files by email or Google Drive. But what if you make changes that make the software even more useful. And even worse - other people have also contributed to your code, creating several versions of the same file. How can you compile all of these different file versions to one (hopefully) working script?
66

7-
There are so many introductory tutorials for using [Git](https://git-scm.com/docs) and [GitHub](https://guides.github.com/activities/hello-world/), which can be daunting to compile and apply to research projects. My goal is to create a concise, step-by-step resource for maintaining your software projects on GitHub.
7+
Git. And GitHub.
8+
9+
These [version control](https://www.atlassian.com/git/tutorials/what-is-version-control) tools allow teams of people to manage changes in source code over time. Anyone can download the latest version of your project. Also, anyone can upload their improvements on your project, making it super easy to share code. Finally, it save your code as you add onto this database, so if you or your teammates introduce bugs into the source code, you can re-wind the clock and download the latest working version.
810

9-
Everything you need is to get started can be found [here]().
11+
These are just a few of the many positive aspects of version control. For a more in-depth discussion, you can read the official documentation (which I **highly** encourage you to do), but this repository is meant to be a functional guide to quickly using Git and GitHub for your research project.
12+
13+
### Why another GitHub tutorial?
14+
There are so many introductory tutorials for using [Git](https://git-scm.com/docs) and [GitHub](https://guides.github.com/activities/hello-world/), which can be daunting to compile and apply to research projects. My goal is to create a concise, step-by-step resource for maintaining your software projects on GitHub.
1015

1116
If you have suggestions for improving this tutorial, read more on raising an [Issue](https://guides.github.com/features/issues/) or a [Pull Request](https://help.github.com/en/articles/about-pull-requests).
1217

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy