Sasserisop
/
MATH201
1
0
Fork 1
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Sasserisop 2023-09-30 22:55:13 -06:00
parent 98f3423ae6
commit 108046386c
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,17 +1,20 @@
# 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.
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 [content](./master/content) folder. The notes are then built into a website using [HUGO](https://gohugo.io), 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.
This whole thing is very experimental. I appreciate any help!
# Can I steal your repository and host my own notes server?
Yes. Consider sharing it with your classmates ;)
Here's a quick rundown of how to build from source:
1) clone the repository
2) make sure you have hugo installed
3) open a command prompt in the MATH201/ directory and run the command ```hugo serve```
4) visit your site by opening http://localhost:1313 on your browser.
# 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.
Yes. You might need to contact me directly so we can get it to work.