MTSR/minetest_modding_book
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update writing guide

Browse Source
This commit is contained in:
rubenwardy 2021-01-25 08:57:13 +00:00
parent 6622a49cd1
commit c258e67f35
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -23,15 +23,25 @@ License: CC-BY-SA 3.0
I'm happy to fix the formatting of any chapters. It is I'm happy to fix the formatting of any chapters. It is
the writing which is the hard bit, not the formatting. the writing which is the hard bit, not the formatting.
### Chapter Guidelines ### Chapter and Writing Guide
Grammar and such:
* British English, except when referring common code words like `color` and
`initialize`.
* Prefer pronounless text, but `you` if you must. Never `we` nor `I`. * Prefer pronounless text, but `you` if you must. Never `we` nor `I`.
* Titles and subheadings should be in Title Case.
* References to code (such as function names) should be formatted as \`inline-code`.
* Italics used for emphasis, not necessarily for technical words.
* Full stops and correct punctionation, except for lists without full sentences.
Formatting:
* Do not rely on anything that isn't printable to a physical book. * Do not rely on anything that isn't printable to a physical book.
* Any links must be invisible - ie: if they're removed, then the chapter must * Any links must be invisible - ie: if they're removed, then the chapter must
still make sense. still make sense.
* Table of contents for each chapter with anchor links. * Table of contents for each chapter with anchor links.
* Add `your turn`s to the end of a chapter when relevant. * Add `your turn`s to the end of a chapter when relevant.
* Titles and subheadings should be in Title Case.
### Making a Chapter ### Making a Chapter