Added diagram and documentation to README

Author: gabrieldiem

README.md

@@ -2,6 +2,24 @@
 
 Este repositorio contiene la solución propuesta para la PoC detallada en la [consigna](./TP2_Threads_Enunciado.pdf).
 
+## Diagrama de hilos
+
+El diagrama se puede ver con más detalle descargando la imagen ubicada en [./docs/threads_diagram.png](./docs/threads_diagram.png) o el mismo archivo drawio [./docs/threads_diagram.drawio](./docs/threads_diagram.drawio).
+
+<img src="./docs/threads_diagram.png">
+
+## Queues
+
+Todas las Queues utilizadas fueron del tipo unbounded, entendiendo que el sistema podrá tomar una cantidad virtualmente infinita de clientes.
+
+Las queues de los ClientConnections son bloqueantes porque me interesa que esos threads no hagan busy wait.
+
+Los pop de las queues con los que JazzJackrabbit2GameServer debe interactuar son no bloqueantes ya que no quiere bloquear el gameloop. Sin embargo, los push de las mismas son bloqueantes.
+
+## Tick system
+
+Para el servidor se utiliza un sistema de ticks, inspirado en el funcionamiente del motor Source by Valve. Así como un frame es una actualización de la imagen gráfica que renderiza un motor gráfico. Un tick o "gameframe" es una actualización de la lógica/estado del juego. 
+
 ## Setup
 
 Instalar pre-commit hooks:
@@ -31,10 +49,7 @@ Compilación con código con wrap randomizado de sockets:
 make wrapsocks=1
 ```
 
-## Running
-
-#### Multi client
-
+## Running multi client
 
 Correr tests sin valgrind:
 ```shell
@@ -45,18 +60,26 @@ Correr tests con valgrind:
 ```shell
 ./run_tests.sh ./ casos/ multi-client valgrind 60 10
 ```
-#### Comparación outputs
+## Comparación outputs
 
 Comparar outputs:
 ```shell
 ./compare_outputs.sh casos/ salidas/
 ```
 
+
+## Supresión de flags de cppcheck
+
+En algunos headers (.h) puntuales se suprimió el warning `unusedStructMember` de cppcheck. Esta decisión fue tomada porque es un falso positivo, en todos los casos que sucede, es sólo en headers de clases sobre variables privadas que sí se usan dentro del código (en el .cpp).
+
+En el método Army::receive_attack de la clase Army, se suprimió el flag `useStlAlgorithm`, dado que el algoritmo sugerido por cppcheck no cumplía con las necesidades del método. Así que se continuó usando un ranged-based for loop.
+
+
 ## Licencia
 
 GPL v2
 
 ## Código fuente utilizado
 
 Se agradece el código proveído por la cátedra para los sockets, threads y queue. Se trabajó sobre ese código y se lo modificó.
-Código fuente usado bajo licencia GPL v2: https://github.com/eldipa/sockets-en-cpp agradecimiento a [@eldipa](https://github.com/eldipa).
+Código fuente usado bajo licencia GPL v2: https://github.com/eldipa/sockets-en-cpp y https://github.com/eldipa/hands-on-threads agradecimiento a [@eldipa](https://github.com/eldipa).