Specification: Template - noodlecollie/crowbar GitHub Wiki
Specification pages should follow this formatting template.
This is the introduction area which gives a brief description of the content. It should be understandable by enthusiasts without needing knowledge of the specific implementation or detailed maths.
Specification
For Attributes
Attribute | Type | Description | Implemented? |
---|---|---|---|
Name of Attribute | Attribute's type - Float, 2D Vector, etc. | A full decription of the attribute along with units in italics, if any. References to other attributes should be written in bold. | Whether the attribute's functionality has been correctly implemented. Can be left blank if no implementation has taken place at all yet. |
... | ... | ... | ... |
Further Notes
- Notes should be listed here. References to attributes should be written in bold.
Method
-
A numbered list specifying the implementation algorithm.
-
Values from above should be referenced in bold.
Resources
Matrices
Matrix From Co-ordinate System A to Co-ordinate System B
Input
Name | Type | Description |
---|---|---|
Name of input, in camel case | Type of input - Float, 2D Vector, etc. | Description of input along with units in italics, if any. |
... | ... | ... |
Pseudocode
QMatrix4x4(
a, b, c, d,
e, f, g, h,
i, j, k, m
n, p, q, r
);