Skip to content

Commit

Permalink
Grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
Hal47 authored Sep 24, 2018
1 parent 16b96f6 commit bd56bcd
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,42 +33,42 @@ _____________
- "Textures.def" is a database of known texture hashes
Standardisation
_______________
introduction
Introduction
____________
with a view towards improving file size/general code legibility as well as ensuring that the code all flows together as one; it becomes clear that guidelines need to be created in order to promote these values. please feel free to discuss these choices & make changes as & when needed to ensure that the largest number possible find the code legible & easy to use whilst also performing at its best.
With a view towards improving file size/general code legibility as well as ensuring that the code all flows together as one; it becomes clear that guidelines need to be created in order to promote these values. please feel free to discuss these choices & make changes as & when needed to ensure that the largest number possible find the code legible & easy to use whilst also performing at its best.
__________
sectioning
Sectioning
__________
when doing this please use underscores as they join together, creating a smooth, neat, connected line. ensure they only underline the length of the word & only use them above & below the section header to avoid confusion. done this way a section header need not have an upper gap. each section header should only take up one line, with an additional line above and below for the underscores.
When doing this please use underscores as they join together, creating a smooth, neat, connected line. ensure they only underline the length of the word & only use them above & below the section header to avoid confusion. done this way a section header need not have an upper gap. each section header should only take up one line, with an additional line above and below for the underscores.
___________________
commenting:one line
Commenting:one line
___________________
please comment using "//". using "/*" & "*/" for just one line adds unnecessary extra characters & is easier to break accidentally. do not leave a space before or after the mark used to denote a comment.
Please comment using "//". using "/*" & "*/" for just one line adds unnecessary extra characters & is easier to break accidentally. do not leave a space before or after the mark used to denote a comment.
____________________
commenting:two lines
Commenting:two lines
____________________
please comment "/*" & "*/". using "//" for multiple lines adds unnecessary extra characters. if required, "*" may be used to align text on lines below the topmost line along with a preceding space however only do this if necessary, otherwise do not use any spaces or other such characters for alignment. do not leave spaces around the comment marks.
Please comment "/*" & "*/". using "//" for multiple lines adds unnecessary extra characters. if required, "*" may be used to align text on lines below the topmost line along with a preceding space however only do this if necessary, otherwise do not use any spaces or other such characters for alignment. do not leave spaces around the comment marks.
___________
empty lines
Empty lines
___________
put simply, don't. it is rare that this would even be required.
Put simply, don't. it is rare that this would even be required.
_______
quoting
Quoting
_______
please follow the author's example by using ""
Please follow the author's example by using ""
_____
lists
Lists
_____
please follow the author's example by creating a section header (where applicable) & subsequently preceding each list item with "- ". when unable to use a section header please write a statement ending in ":".
Please follow the author's example by creating a section header (where applicable) & subsequently preceding each list item with "- ". when unable to use a section header please write a statement ending in ":".
______________________
writing the word "and"
Writing the word "and"
______________________
please use "&". if it is required during a quote you may use "and"
Please use "&". if it is required during a quote you may use "and"
______
colons
Colons
______
do not add a space following them.
Do not add a space following them.
__________
signatures
Signatures
__________
please follow the the authors example by preceding a signature with "- "
Please follow the the authors example by preceding a signature with "- "

0 comments on commit bd56bcd

Please sign in to comment.