Add Figures, Tables and Equations Guidelines (#13)

* basic report structure * added chapters to main, added chapter to team 6 * figures and tables guidelines * Update README.md Co-authored-by: Jason Zheng <[email protected]> * Update README.md Co-authored-by: Jason Zheng <[email protected]> * Update README.md Co-authored-by: Jason Zheng <[email protected]> Co-authored-by: Jason Zheng <[email protected]>
SOMAS2021 · Jan 5, 2022 · c4c5dad · c4c5dad
1 parent 603349d
commit c4c5dad
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,3 +26,17 @@ It is important that your writing is correct and consistent.
 
 You should review your writing for correct spelling, grammar, and punctuation.
 
+## Figures, Tables and Equations
+
+Figures should add to the text. Do not add redundant figures since they can confuse the reader and distract them from the important points in the text.
+
+Figures, tables and similar objects should always be talked about in the text. They also need to be referred to by figure number and not position. Add a label to your figure using `\label{fig:YOUR_LABEL_HERE}` and refer to it in text using `Figure \ref{fig:YOUR_LABEL_HERE}`.
+e.g. 
+- Good - "as you can see in Figure 6"
+- Bad  - "as you can see in the figure below"
+
+Equations should be refered to using their equation number with parenthesis around the equation number. Remember to add labels and use references when writing so you don't have to manually renumber things.
+e.g. 
+- Good - "as shown in (6)"
+- Bad  - "as shown in Equation 6"
+- Bad  - "as shown in the equation below"