This is the solution to Homework 1: Problems - Designing a Github README file and web-page for your project.

The following figure illustrates the grade distribution for this homework.

Maximum possible points, excluding bonus question, is 100.
Maximum possible points, including bonus question, is 200.



Use the following Markdown language references, or any other reference that you find or prefer, to design a Github-interpretable README file for each of folders in your project for this course, and a Github web-page for your project.


1. Include the following information with the following format and information in your main directory readme.md file:

Beginning of the README file’s content



ECL2017S - Engineering Computation Lab Project (Spring 2017)


Name: <first name> <last name>
UT EID: <your UT EID>
Email: <your email>
Department: Department of Aerospace Engineering and Engineering Mechanics
University: The University of Texas at Austin
Level: Undergraduate - <Freshman(1st year) / Sophomore(2nd year) / Junior(3rd year) / Senior(4th year)>
ECL Class Position: Student
Course Webpage: https://www.shahmoradi.org/ECL2017S/
Photo:

Amir Shahmoradi

Description of the project’s content


This repository contains my homework, quizzes, and virtually every effort that I have made for ECL2017S class. The structure of the project is the following:

  • homework: (the homework hyperlink should take the reader to the homework folder)
    This directory contains all my homework submissions, each of which is a folder properly named with homework number, containing the homework submission.

  • quiz: (the quiz hyperlink should take the reader to the quizzes folder)
    This directory contains all my quiz submissions, each of which is a folder properly named with quiz number, containing the quiz submission.

  • exam: (the exam hyperlink should take the reader to the exams folder)
    This directory contains all my exam submissions, each of which is a folder properly named with exam name or number, containing the exam submission.

For questions and troubleshooting, please contact:

<your name>
<your email>
<any other contact or signature information that you would like to add>

I have not failed. I’ve just found 10,000 ways that won’t work.
Thomas A. Edison



End of the README file’s content



Answer:


Use the following Markdown code in your readme.md file to get the exact same behavior as requested above:

#### ECL2017S - Engineering Computation Lab Project (Spring 2017)
<br>
**Name:** \<first name> \<last name>  
**UT EID:** \<your UT EID>  
**Email:** \<your email>  
**Department:** [Department of Aerospace Engineering and Engineering Mechanics](http://www.ae.utexas.edu/)  
**University:** [The University of Texas at Austin](http://www.utexas.edu/)  
**Level:** Undergraduate - \<Freshman(1st year) / Sophomore(2nd year) / Junior(3rd year) / Senior(4th year)>  
**ECL Class Position:** Student  
**Course Webpage:** <https://www.shahmoradi.org/ECL2017S/>  
**Photo:**  

![Amir Shahmoradi](../../images/amir.png)  

#### Description of the project's content
<br> This repository contains my homework, quizzes, and virtually every effort that I have made for [ECL2017S class](https://www.shahmoradi.org/ECL2017S/). The structure of the project is the following:

* **[homework](#homework):** (the homework hyperlink should take the reader to the homework folder)  
    This directory contains all my homework submissions, each of which is a folder properly named with homework number, containing the homework submission.  
    <br>
* **[quiz](#quiz):** (the quiz hyperlink should take the reader to the quizzes folder)  
    This directory contains all my quiz submissions, each of which is a folder properly named with quiz number, containing the quiz submission.  
    <br>
* **[exam](#exam):** (the exam hyperlink should take the reader to the exams folder)  
    This directory contains all my exam submissions, each of which is a folder properly named with exam name or number, containing the exam submission.  
    <br>

For questions and troubleshooting, please contact:  

\<your name>  
\<your email>  
\<any other contact or signature information that you would like to add>

>I have not failed. I've just found 10,000 ways that won't work.  
>[Thomas A. Edison](https://en.wikipedia.org/wiki/Thomas_Edison){:target="_blank"}

Note that you will have to change the relevant information and hyper-references in the above Mardown code to those that match your own information in your own repository (including your own photo).




2.  (Bonus, not mandatory) Design a simple Github page for your project, using the main directory’s readme.md file. Submit the link to the page as your answer. Note that you don’t need to add anything extra to your readme file.

Answer: Ask me in class or during office hours to teach you how to do it.

Comments