A brief introduction to Git and GitHub can be found in the "Hello World" tutorial \cite{GitHubStaff2016b}, from GitHub Guides \cite{GitHubStaff20XY}.
Use GitHub, or another Web-based source-code-hosting service, to share your portfolio online with other people \cite{Nguyen2014}. The portfolio can be used for software development, data science, embedded hardware design, VLSI design, UI/UX design, and/or product design.
Contents:
- Brief Introduction to Git
- Brief Introduction to GitHub
- Customizing Your GitHub Profile
- GitHub Repositories
- Creating A New GitHub Repository
- Modifying A GitHub Repository
- Adding Collaborators to A GitHub Repository
- Removing Collaborators From A GitHub Repository
- Setting Your GitHub Repository to Private
- Creating a New File Online
- Deleting a File Online
- Uploading Files Online
- Upload Folders/Directories Online
- Finding the URL to Clone a GitHub Repository
- Generating SSH Keys
- Associating SSH Public Keys with a GitHub Profile
- Cloning a GitHub Repository by SSH, via the Command-Line Interface
- Documenting Projects
- Sharing Code Fragments via GitHub Gist
- Miscellaneous Information
- References
- Author Information
Git is a free and open source distributed version control system. You can use it to track different versions/revisions of your projects.
To modify a Git repository using the
command-line interface on Unix-like operating systems (such as macOS, GNU/Linux, freeBSD, NetBSD, or Open BSD),
and upload this modification (via commit and push commands) to my
server/Web -based GitHub repository,
run the following sequence of commands.
git add -A(to add file modifications in the repository to this commit)git commit -m [Descriptive text for this set of file additions/modifications/deletions](commit this set of file modifications to the "holding stage," before this set of modifications is pushed/committed to the GitHub repository).git push(this set of file modifications to the server or Web-based Git service)
Resources for learning about Git:
- https://www.atlassian.com/git/tutorials
- https://www.atlassian.com/git/tutorials/learn-git-with-bitbucket-cloud
The main web page for GitHub is shown below, and is available at: https://github.com/.
The main web page for GitHub, after logging in, is shown below.
To customize your GitHub profile, click on the icon with your profile picture and select the "Settings" option from the drop-down list.
You can edit profile information for your GitHub account, such as your name, to disclose/display an email address publicly (and if so, which email address) or avoid displaying any email address, a short biography of yourself, the URL of your web page, and your current location.
To change username and password of your GitHub profile, select the "Account" option of the menu on the right by clicking on it to go to the "Account" page.
To change your username for your GitHub profile, click on change username. You will be warned about changing your username. Proceed by clicking on the "I understand, let's change my username" option/button.
Enter your new username, and click on the "Change my username" option/button.
The next screen should indicate that your username has been renamed, and it should also show a button to bring you to new profile settings.
To add and/or change email addresses associated with your GitHub profile, select the "Emails" option of the "Personal settings" menu on the right.
Each project that you work on can be stored locally on your computer, and online with your cloud-based GitHub account. To store your project with your GitHub account, create and associate a GitHub repository to your project. This GitHub repository would contain additions, deletions, or modifications of your files associated with that project. For files stored in the GitHub repository as text files (e.g., using the ASCII character set, UTF-8 character encoding, or similar text file formats), each commit/modification pushed to your GitHub repository would show the differences between the files in the current commit/version and the previous commit/version (if they exist).
To create a new GitHub repository, click on the plus icon "+" on the top-right corner of the GitHub page, on the left of the profile picture icon.
This brings you to a page to create a new GitHub repository. Provide a name for the GitHub repository that you are trying to create. Also, provide a description for the GitHub repository. In addition, select either the "Public" or "Private" option for the GitHub repository. Furthermore, if you want a new/empty README file for the GitHub repository, check the "Initialize this repository with a README" option.
To avoid committing temporary files associated with the main/primary computer language (supported by GitHub) used in your repository, click on the "Add .gitignore: None" button and select one of the computer languages from the drop-down list. If you are using computer languages not supported by GitHub in your project/repository, ignore this step.
Click on the "Create repository" button at the bottom of the web page.
When viewing a text file in the GitHub repository, indicate if the text file can be edited by checking if there is an "editing" icon that is shaped like a pencil/pen. If this "editing" icon exists, click on the "editing" icon to edit the text file. In the picture shown below, this "editing" icon is circled in red.
This brings you to an online text editor to edit the text file, which has read and write permissions, so that the file can be modified and saved online (i.e., commit and push the modification).
In the text boxes under the "Commit changes" label, write a summary of the modification in the top text box labeled, and write an optional brief description of the modification in the bottom text box. To accept this modification of the file, and commit (or upload) this modification, click on the green "Commit changes" button in the bottom-left corner of the Web page.
The updated README file is shown below.
To modify a GitHub repository using the
command-line interface on Unix-like operating systems (such as macOS, GNU/Linux, freeBSD, NetBSD, or Open BSD),
and upload this modification (via commit and push commands) to my
GitHub repository,
run the following sequence of commands.
git add -A(to add file modifications in the repository to this commit)git commit -m [Descriptive text for this set of file additions/modifications/deletions](commit this set of file modifications to the "holding stage," before this set of modifications is pushed/committed to the GitHub repository).git push
To add collaborators to a GitHub repository, begin by clicking on the "Settings" tab of the repository, which is the rightmost tab near the top of the web page for the repository. This "Settings" tab is circled in red.
On the vertical list/menu beginning with "Options" on the right side of the "Settings" page of the GitHub repository, click on the "Collaborators" option. This "Collaborators" option is circled in red.
To add collaborators to your GitHub repository, enter their GitHub username or email addresses associated with their GitHub account, and click on the "Add collaborator" button on the center-right side of the page.
Go to the "Collaborators" page via the "Settings" page of the GitHub repository, and click on the cross on the right side of a collaborator who you want to remove access to the repository.
Going to the "Settings" page of the GitHub repository.
Go to the "Collaborators" page of the GitHub repository.
Click on the cross on the right side of a collaborator who you want to remove access to the repository.
To set your GitHub repository to private, begin by clicking on the "Settings" tab of the repository, which is the rightmost tab near the top of the web page for the repository. This "Settings" tab is circled in red.
Initial "Settings" page of the GitHub repository.
Scroll to the bottom of the "Settings" page of the GitHub repository.
Click on the grey/gray "Make private" button (circled in red) in the "Danger Zone".
The tab/window would be darkened, and a pseudo-"pop-up window" would ask you to type in the name of the GitHub repository that you are trying to make private.
Type in the name of the GitHub repository, and click on the "I understand, make this repository private." button (circled in red).
You will be redirected to a page to authenticate your identity. This acts as a second warning to remind you of the seriousness of your action in making the repository private.
You will return to the "Settings" page of the GitHub repository, with the "Private" flag (circled in red) beside the name of the repository (near the top left corner of the window/tab).
When you scroll to the bottom of the page, you will notice a "Make public" button (circled in red) in the "Danger Zone". This is because the GitHub repository is currently private, and cannot be made "private private". However, it has the "Make public" button in the "Danger Zone" to allow the administrator/collaborator of the GitHub repository make set the GitHub repository to public, so that everyone can see it again.
Similarly, when you return to the main page of the GitHub repository, you will notice the "Private" flag (circled in red) beside the name of the repository (near the top left corner of the window/tab).
A new file for your repository can be generated by clicking the "Create new file" button near the top of the repositories.
An online text editor would be opened for you to edit/write a text file. This is shown below.
Directory of file to be deleted.
File to be deleted. Click on the icon of a trash can on the right (circled in red) to delete the file.
Deleting file.
Add a comment to describe this file deletion. And, click on the "Commit changes" green button below to confirm deletion of the file.
File deleted.
You can upload files for your repository by clicking the "Upload files" button near the top of the repositories.
Drag files to the shaded region labeled "Drag files here to add them to your repository," or click the hyperlink labeled "choose your files" to select files to be uploaded.
You can also upload folders/directories for your repository by clicking the "Upload files" button near the top of the repositories.
Drag folders/directories to the shaded region labeled "Drag files here to add them to your repository."
Initial Git repository without any syllabus.
Uploaded directory with two syllabi to the Git repository.
Added directory with two syllabi.
The two added syllabi.
Adding more syllabi to the Git repository, by uploading the modified directory (initial directory with additional files) again.
IMPORTANT NOTE!!!: Initial uploaded syllabi were not overwritten.
The directory/folder is modified. Initial uploaded syllabi were not overwritten.
Information regarding the initial upload of files is retained, while other files are added to the directory/folder (that was uploaded).
To determine the URL to clone a GitHub repository by SSH, click on the green "Clone or download" button on the right side of the Web page for the GitHub repository. Subsequently, click on the "copy to clipboard" icon to copy the URL (for the SSH protocol).
To determine the URL to clone a GitHub repository by HTTPS, click on the green "Clone or download" button on the right side of the Web page for the GitHub repository. Subsequently, click on the "copy to clipboard" icon to copy the URL (for the HTTPS protocol).
To generate a pair of SSH Keys (i.e., the public key and the corresponding
private key) for the Secure Shell protocol, or SSH protocol
from the command line in the Terminal application,
use the ssh-keygen -f [*location where SSH private and public key would be stored*]/[name associated with this pair of SSH keys] -C [A description that would be associated with this pair of SSH keys] command.
The contents of the public SHH key can be read as a text file.
Go to your GitHub profile's "Settings" page, and under the "Personal settings" list on the right, select the "SSH and GPG keys" option. Click on the green "New SSH key" button to add a SSH key to this repository. Also, for each displayed SSH key that is associated with your GitHub profile, you can click the grey button with the "Delete" label to dissociate that SSH key from your GitHub profile.
When adding a public SSH key to your GitHub profile, describe the public SSH key (e.g., the computer account and the computer where its corresponding private SSH key is stored) in the text box labeled "Title" and paste the public SSH key into the text box labeled "Key".
To clone a GitHub repository by SSH, via the command-line interface, the following prerequisites/preconditions must be satisfied.
- A pair of SSH keys (specifically, a public SSH key and a private SSH key) must be associated with SSH connections to the GitHub server. See the subsubsection on "Generating SSH Keys" to obtain such pairs of SSH keys.
- Associate the public SSH key (of any pair of SSH key) for SSH connections from a computer, which contains the associated private SSH key, with your GitHub profile. See subsubsection on "Associating SSH Public Keys with a GitHub Profile" to do so.
From the command-line interface, use the git clone [URL of *GitHub* repository for the SSH protocol] command to clone a GitHub repository by SSH.
Visually, the contents of a directory where a Git/GitHub repository would be clone are shown before and after the cloning process.
Before cloning a Git/GitHub repository, the contents of the directory are shown below.
After cloning a Git/GitHub repository, the contents of the directory are shown below.
The contents of the cloned Git/GitHub repository are shown below.
The Documenting your projects on GitHub \cite{GitHubStaff2016c} document shows us how we can document our projects for software development, data science, or otherwise, such that other people can quickly and easily find information that they need about your project/repository.
\cite{Gruber2004} is a seminal document on Markdown, which we can use as a reference for Markdown. Markdown provides us with a simple way to document projects hosted in GitHub repositories, or other Web-based source-code-hosting service.
Quick look-up references/manuals for Markdown are:
We can share code fragments via GitHub Gist at: https://gist.github.com/.
Use the Making Your Code Citable \cite{GitHubStaff2016d} document to learn how to assign a digital object identifier (DOI), so that a GitHub repository can be cited along with its associated research publications.
BibTeX entries for references that I used.
@misc{GitHubStaff2016b,
Address = {San Francisco, {CA}},
Author = {{GitHub staff}},
Howpublished = {Available online from {\it GitHub: GitHub Guides} at: \url{https://guides.github.com/activities/hello-world/}; January 24, 2018 was the last accessed date},
Month = {April 7},
Publisher = {{GitHub, Inc.}},
Title = {Hello World},
Url = {https://guides.github.com/activities/hello-world/},
Year = {2016}}
@misc{GitHubStaff20XY,
Address = {San Francisco, {CA}},
Author = {{GitHub staff}},
Howpublished = {Available online from {\it GitHub} at: \url{https://guides.github.com/}; January 24, 2018 was the last accessed date},
Publisher = {{GitHub, Inc.}},
Title = {{GitHub} Guides},
Url = {https://guides.github.com/}}
@misc{Chapellier2018,
Address = {San Francisco, {CA}},
Author = {Cyril Chapellier},
Howpublished = {Available online from {\it GitHub: tchapi} at: \url{https://github.com/tchapi/markdown-cheatsheet/blob/master/README.md}; December 7, 2018 was the last accessed date},
Month = {August 20},
Publisher = {{GitHub, Inc.}},
Title = {Markdown Cheatsheet: Markdown Cheatsheet for GitHub},
Url = {https://github.com/tchapi/markdown-cheatsheet/blob/master/README.md},
Year = {2018}}
@misc{Nguyen2014,
Address = {San Francisco, {CA}},
Author = {Dan Nguyen},
Howpublished = {Available online from {\it Dan Nguyen's web page} at: \url{https://dannguyen.github.io/github-for-portfolios/}; February 28, 2017 was the last accessed date},
Month = {April 13},
Publisher = {{GitHub, Inc.}},
Title = {Build a Web Portfolio from Scratch: with {Github Pages}},
Url = {https://dannguyen.github.io/github-for-portfolios/},
Year = {2014}}
@misc{Gruber2004,
Author = {John Gruber},
Howpublished = {Available online as version 1.0.1 at: \url{http://daringfireball.net/projects/markdown/}; October 9, 2015 was the last accessed date},
Month = {December 17},
Publisher = {The Daring Fireball Company {LLC}},
Title = {Markdown},
Url = {http://daringfireball.net/projects/markdown/},
Year = {2004}}
@book{Kopka2004,
Address = {Boston, {MA}},
Author = {Kopka, Helmut and Daly, Patrick W.},
Edition = {Fourth},
Publisher = {Addison-Wesley},
Series = {Addison-Wesley Series on Tools and Techniques for Computer Typesetting},
Title = {Guide to {\LaTeX}},
Year = {2004}}
@misc{GitHubStaff2016d,
Address = {San Francisco, {CA}},
Author = {{GitHub staff}},
Howpublished = {Available online from {\it GitHub: GitHub Guides} at: \url{https://guides.github.com/activities/citable-code/}; January 24, 2018 was the last accessed date},
Month = {October},
Publisher = {{GitHub, Inc.}},
Title = {Making Your Code Citable},
Url = {https://guides.github.com/activities/citable-code/},
Year = {2016}}
@misc{GitHubStaff2016c,
Address = {San Francisco, {CA}},
Author = {{GitHub staff}},
Howpublished = {Available online from {\it GitHub: GitHub Guides} at: \url{https://guides.github.com/features/wikis/}; January 24, 2018 was the last accessed date},
Month = {July 15},
Publisher = {{GitHub, Inc.}},
Title = {Documenting your projects on {GitHub}},
Url = {https://guides.github.com/features/wikis/},
Year = {2016}}
@misc{GitHubStaff2014,
Address = {San Francisco, {CA}},
Author = {{GitHub staff}},
Howpublished = {Available online from {\it GitHub: GitHub Guides} at: \url{https://guides.github.com/features/mastering-markdown/} and \url{https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf}; January 24, 2018 was the last accessed date},
Month = {January 15},
Publisher = {{GitHub, Inc.}},
Title = {Mastering {Markdown}},
Url = {https://guides.github.com/features/mastering-markdown/},
Year = {2014}}
I use LaTeX and BibTeX notations \cite{Kopka2004} for in-text citations in this document.
The MIT License (MIT)
Copyright (c) <2019> Zhiyang Ong
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Email address: echo "cukj -wb- 23wU4X5M589 TROJANS cqkH wiuz2y 0f Mw Stanford" | awk '{ sub("23wU4X5M589","F.d_c_b. ") sub("Stanford","d0mA1n"); print $5, $2, $8; for (i=1; i<=1; i++) print "6\b"; print $9, $7, $6 }' | sed y/kqcbuHwM62z/gnotrzadqmC/ | tr 'q' ' ' | tr -d [:cntrl:] | tr -d 'ir' | tr y "\n" Don't compromise my computing accounts. You have been warned.