Update README.md
This commit is contained in:
parent
f6408c784c
commit
a6c86f9a71
|
@ -1,6 +1,6 @@
|
||||||
# What is this?
|
# What is this?
|
||||||
Welcome! This repository is the source code behind the page [sasserisop.com/MATH201](https://sasserisop.com/MATH201)
|
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 [content](./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.
|
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](./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](https://katex.org).
|
||||||
|
|
||||||
# Can I contribute?
|
# Can I contribute?
|
||||||
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.
|
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.
|
||||||
|
@ -11,9 +11,9 @@ This whole thing is very experimental. I appreciate any help!
|
||||||
Yes. Consider sharing it with your classmates ;)
|
Yes. Consider sharing it with your classmates ;)
|
||||||
|
|
||||||
Here's a quick rundown of how to build from source:
|
Here's a quick rundown of how to build from source:
|
||||||
1) clone the repository
|
1) download or clone the repository ```git clone https://git.sasserisop.com/Sasserisop/MATH201```
|
||||||
2) make sure you have hugo installed
|
2) make sure you have hugo installed
|
||||||
3) open a command prompt in the MATH201/ directory and run the command ```hugo serve```
|
3) open a command prompt in the MATH201/ directory and run the command ```hugo server --disableFastRender```
|
||||||
4) visit your site by opening http://localhost:1313 on your browser.
|
4) visit your site by opening http://localhost:1313 on your browser.
|
||||||
|
|
||||||
# Can I add my own notes? And for other classes?
|
# Can I add my own notes? And for other classes?
|
||||||
|
|
Loading…
Reference in New Issue