ADD README.md

README.md

@@ -1,2 +1,43 @@
-# cellular_automaton
-Conway's Game of Life like simulation
+# Conway's Game of Life
+
+## Introduction
+
+This project is focused on implementation of a celullar automaton, the conway's game of life.
+
+## Compiling and Usage
+
+1. Download the project and moves into the root directory
+    ```
+    git clone https://github.com/RanieriSantos/cellular_automaton && cd cellular_automaton/
+    ``` 
+
+2. Start the compiling process
+    ```
+    make
+    ```
+3. Just run as usual (assuming `$` is the terminal prompt):
+    ```
+    ./glife [options] <input_cfg_file>
+    ```
+
+## Contributing
+You are welcome! Create the pull requests. 
+
+For major changes, please, open an issue first to discuss what you would like to change.
+
+## Support
+* Twitter: [@imns1ght](https://twitter.com/imns1ght) | E-mail: [jeffersonbrunoIT [at] gmail [dot] com](mailto:[email protected])
+* E-mail [RanieriSantos [at] protonmail [dot] com](mailto:[email protected])
+
+## Authors and acknowledgment
+### Authors
+* [Jefferson Bruno (imns1ght)](https://imns1ght.github.io)
+* [Ranieri Santos](https://github.com/RanieriSantos)
+
+### Acknowledgment
+* [Professor Selan R. dos Santos](https://www.dimap.ufrn.br/~selan/)
+* [GeeksforGeeks](https://www.geeksforgeeks.org/)
+* [C++ Reference](https://en.cppreference.com/w/)
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

include/simulation.h

@@ -16,7 +16,6 @@
 #include <string>     // std::string
 #include <vector>     // std::vector
 
-//! Auxiliar constants
 const int alive = 1;              //!< Alive cell.
 const int dead = 0;               //!< Dead cell.
 const int int_size = 2147483647;  //!< Standard value to maximum number of generations, "Infinite".