Scribd
Upload
3 views

Get started with GitHub

This document provides a guide on setting up a GitHub account and creating repositories for portfolio documentation. It outlines the structure of a README file, including sections like Project Title, Introduction, Modeling and Evaluation, and Conclusion. Additionally, it introduces Markdown as a formatting tool for GitHub and offers resources for further learning.

Uploaded by

Nouhoum Ibrahim Traoré
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
3 views

Get started with GitHub

This document provides a guide on setting up a GitHub account and creating repositories for portfolio documentation. It outlines the structure of a README file, including sections like Project Title, Introduction, Modeling and Evaluation, and Conclusion. Additionally, it introduces Markdown as a formatting tool for GitHub and offers resources for further learning.

Uploaded by

Nouhoum Ibrahim Traoré
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

Get started with GitHub

Set up a GitHub account


To create your GitHub account, access the links and follow the steps provided.

1. Set up an account on GitHub


2. After setting up a GitHub account, create separate repositories for your
portfolio documentation. Repositories are like folders and often referred to as
“repos” for short. Review Create a repo for more information.
3. Each repository, or repo folder, will contain your project files and a “README”
file. A README is a text file that provides an overview of your project.
○ Some example sections you may want to include are:
■ A Project Title: A descriptive title related to the project that may
interest your prospective employer. Do not title your project
“Portfolio Project”; instead, try adding a title that defines the
project you have worked on.
■ A Project Introduction: Two to three sentences that state the
problem you solved, the data used for the project, and your
modeling results.
■ Modeling and Evaluation: Name and describe the models you
used for the project and any corresponding evaluation metrics.
■ Conclusion: Your recommendations for solving the problem and a
description of any future steps you want to take to expand on your
project.

How to use Markdown


Markdown is a simple markup language, similar to HTML. Markdown allows you to
format plaintext documents via GitHub.

Here are a few resource options for you to learn more:

● Basic Syntax
● Markdown Cheat Sheet
● GitHub Markdown Cheatsheet
● GitHub basic writing and formatting syntax
Citations:

# APA Citation Use of Source

GitHub Docs. (2022). Signing up for a new GitHub account. Linked/quoted


https://docs.github.com/en/get-started/signing-up-for-github/
signing-up-for-a-new-github-account

GitHub Docs. (2022). About READMEs. Linked/quoted


https://docs.github.com/en/repositories/managing-your-
repositorys-settings-and-features/customizing-your-
repository/about-readmes

Markdown Guide. (2022). Linked/quoted


https://www.markdownguide.org/basic-syntax/

Markdown Guide. (2022). Linked/quoted


https://www.markdownguide.org/cheat-sheet/

GitHub. (2022). Markdown Cheatsheet. Linked/quoted


https://github.com/adam-p/markdown-here/wiki/Markdown-
Cheatsheet

GitHub Docs. (2022). Basic writing and formatting syntax. Linked/quoted


https://docs.github.com/en/get-started/writing-on-github/gettin
g-started-with-writing-and-formatting-on-github/basic-writing-
and-formatting-syntax

You might also like