Notes/Lecture_Notes
1
0
Fork 0
mirror of https://github.com/dholerobin/Lecture_Notes.git synced 2025-07-01 13:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add guidelines

Browse Source
This commit is contained in:
Pragy Agarwal 2019-10-10 16:55:37 +05:30 committed by GitHub
parent f74aeb5820
commit 8687e577a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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