PrimeO7 / How-to-undervolt-AMD-RYZEN-5800X3D-Guide-with-PBO2-Tuner

Get the Most out of your 5800X3D using PBO Curve Optimizer!
421 stars 27 forks source link

Format code blocks correctly #1

Closed tullo-x86 closed 2 years ago

tullo-x86 commented 2 years ago

GitHub allows for formatting of code blocks to make reading easier; let's do that (and also clean up the PowerShell code a bit)

PrimeO7 commented 2 years ago

Thank you! I'm very new to Github and just started to learn to code and how GitHub works! I didn't know about code blocks. Can you maybe explain what ```pwsh does? I can't seem to find an explanation online.

tullo-x86 commented 2 years ago

Sure! The triple-backtick ``` signals the beginning of a code block, and if you name a language on the same line, GitHub will apply the syntax highlighting rules of that language to the code. In this case, pwsh is an abbreviation of powershell; I believe both work in GH. I know js and javascript work too, as well as cs and csharp, ts and typescript, ruby, python, and so on.

If you type something that doesn't match a language it knows, it'll just leave the code as plain text without any colouring.

GitHub has heaps of documentation on it, too!

PrimeO7 commented 2 years ago

Thank you! 😄