diff --git a/README.md b/README.md index fcf6d00..0de4bfe 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,15 @@ This repository is there to store the combined lecture notes of all the lectures To render math in the notes, use https://chrome.google.com/webstore/detail/mathjax-plugin-for-github/ioemnmodlmafdkllaclgeombjnmnbima + + +Guidelines: +- Keep code snippets in Python/Psuedocode +- For language specific concepts, make sure to contrast it with other languages +- Use LaTeX math mode when possible. + Quick References: + - https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference + - https://jojozhuang.github.io/blog/2018/09/11/mathjax-cheat-sheet-for-mathematical-notation/ +- Soft resize images to appropriate size (use html img tag with inline style) +- Use spaces instead of tabs (important, to keep indentation in code blocks consistent) +- Clearly mark the begin and end of each topic / question by using HR. markdown syntax: `-- --` on a new line