PA 1.4: Git Me a Table

CEGM1000 MUDE: Week 1.3. Due: before Friday, September 27, 2024.

Introduction

You can access the assignment with this link: classroom.github.com/a/s0De54YX

This PA consists of 3 parts:

  1. Read the first chapter in Programming for Week 1.4 about Version Control
  2. Install Git on your computer and set up SSH authentication. as explained in the second chapter
  3. Go through the workflow as shown in the third chapter
  4. Use VS Code to add a table to the file my_table.md, then make a commit and push it to GitHub

The chapters of the textbook contain all the information necessary to complete these steps. Once you have completed the first two steps above, then you can read the instructions below for creating a Markdown table and try it out in my_table.md.

Note: the programming tutorial on Monday of Week 1.4 will cover Git and GitHub, so install Git and attend this session if you anticipate issues with this PA!

Passing the PA

You will pass this PA if:

  1. You set up Git and SSH on your computer
  2. You successfully make a commit on your computer and push the commit to GitHub

You can verify that you passed the assignment by looking for the green circle when you have pushed your commit, it runs automatically just like last week when you uploaded your notebook.

Formatting Tables in Markdown

This is relatively straightforward, once you learn the proper syntax. Note, however, that the most challenging thing about Markdown tables (and Markdown in general) is that every platform interprets the source code (i.e., the text) differently---in other words, what works in VS Code may not work the same in other IDE's, or even on GitHub. Fortunately this is usually fixed with a little trial-and-error, usually with white space (spaces, new lines, etc) or a quick Google search for some example code.

The following are key notes for constructing a table:

Below are two example tables to illustrate how it works.

Table 1: Example table, empty; formatted as source code.

| | | | | :-: | :-: | :-: | | | | |

Table 2: Example with left, center, right justification in columns.

Column 1 Column 2 Column 3
Left Justified Center Right
a b c
1 2 3

Note about viewing the examples: if you are viewing this file on GitHub, the tables above probably display properly, and you will have to click the "raw" or "view source" button to see the source code. If you are viewing this file in a text editor, you will have to use a tool to view the "marked up" version. In VS Code use the "markdown all-in-one" extension (hit CTRL+SHIFT+V once it is installed). This is also useful for this assignment to verify that the table formats properly.

PA 1.4: Try it Yourself!

Now you know everything that is needed to create your own Markdown table, and you can do this in the file my_table.md to complete the assignment.

Edit the file in VS Code, then use the viewing extension to visualize it. You can fill it with any contents you like, and make it big or small. Once you are satisfied with your table, do the following:

Congratulations, you're done!

End of file.

By MUDE Team © 2024 TU Delft. CC BY 4.0. doi: 10.5281/zenodo.16782515.