summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdoardo La Greca2025-04-01 16:13:38 +0200
committerEdoardo La Greca2025-04-01 16:13:38 +0200
commit74fad25e20c20f4c9d8541f37ef1abf368626d88 (patch)
treec49f42eba198526bcce520b5075d7921b6e00c4f
parentdc6612456a541c9d43792c82ef155c72a4da45f2 (diff)
add info about the repository's structure and notes
-rw-r--r--readme.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 46b49e4..71d591d 100644
--- a/readme.md
+++ b/readme.md
@@ -2,7 +2,18 @@
This repository contains notes and code I wrote while following [CIS194](https://www.seas.upenn.edu/~cis1940/spring13/lectures.html), a Haskell course from University of Pennsylvania.
-The repository is structured in lectures. Every directory of the form `lecN` (where `N` is a two-digit number, `lec01`, `lec02`, etc.) in the repository's root is a lecture and it coincides exactly with a week of the course. Inside of each lecture directory there are my notes about it, homework given for that week, and possibly some other files given as part of the homework. My notes contain what I deem to be the most important concepts of the lecture, written as I'd write them if I had to explain the concepts to a friend.
+## Structure of the repository
+
+The repository is structured in lectures. Every directory of the form `lecNN` (where `NN` is a two-digit number, `lec01`, `lec02`, etc.) in the repository's root is a lecture, they are equivalent to weeks in the course's web page.
+
+Inside of each lecture directory there are (where `NN` is the same as the lecture's number):
+- my notes about the lecture (usually named `notesNN.md`)
+- homework given for that week (usually named `hwNN.hs`, unless a specific name is required)
+- possibly some other files given as part of the homework
+
+My notes contain what I deem to be the most important concepts of the lecture, written in an informal way.
+
+Although I always try to rephrase the lecture's text and rewrite it in my own words, some parts of my notes contain exact phrases taken from the course's lectures. I couldn't rewrite those phrases in a way that I liked, so I left them as they were. On the other hand, most of the code examples I wrote, if not all, are literally copied from those given in the lecture's text.
---