From 3f1e10af72a6eb0edeb8d1e91fc5bd4ecc07cc60 Mon Sep 17 00:00:00 2001
From: Pascal Engeler <engelerp@phys.ethz.ch>
Date: Fri, 27 Aug 2021 18:14:59 +0200
Subject: [PATCH] format

---
 README.md | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 448b91f..147223b 100644
--- a/README.md
+++ b/README.md
@@ -106,27 +106,36 @@ Todo
 
 **Public Function Members**
 - `void start_drawing(const float x, const float y)`:
-  - <ins>Desc</ins>: 
+  - **Description** 
 
     Start drawing at coordinates (`x`, `y`) (typically fingerdown location). Doesn't draw anything. 
   
-  - <ins>Pre</ins>:
+  - **Preconditions**
 
-  - <ins>Post</ins>: 
+  - **Postconditions**
   
     Drawing start is set to (x, y).
 
-  - <ins>Notes</ins>: 
+  - **Notes**
     
     Nothing is drawn by this function. (x, y) are typically the fingerdown coordinates.
 
 - `bool draw(const float x, const float y, Toolbox& tb, bool drawing)`
-  - *Desc*: Draw a stroke from the last position to (x, y), with strokewidth controlled by `drawing` (`true`->`tb.drawing_width`, `false`->`tb.erasing_width`).
-  - *Pre*: A `GL_ARRAY_BUFFER` is bound and the Opengl state is set as desired
-  - *Post*: The points of the new segment have been calculated, a call to `glDrawArrays` has been done to draw the segment.
+  - DESCRIPTION
+  
+    Draw a stroke from the last position to (x, y), with strokewidth controlled by `drawing` (`true`->`tb.drawing_width`, `false`->`tb.erasing_width`).
+
+  - PRECONDITIONS 
+  
+    A `GL_ARRAY_BUFFER` is bound and the Opengl state is set as desired
+
+  - POSTCONDITIONS
+  
+    The points of the new segment have been calculated, a call to `glDrawArrays` has been done to draw the segment.
 
     Returns `true` if something was drawn, and `false` else (typically when new point is same as last point).
-  - *Notes*:
+
+  - NOTES
 
 - `void redraw(Toolbox&)`
   - *Desc*: Redraws the last drawn stroke.
-- 
GitLab