From 98f3423ae6c0bc3d9a2593e9dd356c71dbe23b23 Mon Sep 17 00:00:00 2001 From: Sasserisop Date: Sat, 30 Sep 2023 21:11:16 -0600 Subject: [PATCH] added readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad31a94 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# What is this? +Welcome! This repository is the source code behind the page [sasserisop.com/MATH201](https://sasserisop.com/MATH201) +The notes are originally written in markdown. In my case, I write my notes using obsidian during the lecutre and revise it when I'm home, although I am trying to move away from that piece of software. The notes are stored as .md files under the folder content. They are then built into a website using HUGO, a static site generator. I used a theme called [Zettles](https://github.com/crisrojas/Zettels). I have slightly modified it so that it can render math using KaTeX. + +# Can I contribute? +Yes! Absolutely! You can add your own notes or fixes or anything really. You can contribute by creating an issue or by making a pull request. You can also contact me directly if you have any suggestions or concerns: [mail@sasserisop.com](mailto:mail@sasserisop.com) Please note that I will not accept adding instructor materials without their prior consent. I also do not condone academic dishonesty. +# Can I steal your repository and host my own notes server? +Yes. Consider sharing it with your classmates ;) + +# Can I add my own notes? And for other classes? +Yes. You might need to contact me directly so we can get it to work. + +# Todo: +-[] Notes could really use some more mathematical rigor. +Notes could also be more clear and concise. +Add a search by tag feature. +