diff --git a/documents/references.md b/documents/references.md new file mode 100644 index 0000000000000000000000000000000000000000..c52d40ae47a9697e665de8d300868ac429e51173 --- /dev/null +++ b/documents/references.md @@ -0,0 +1,28 @@ +# Roomba AI Simulator - Documents > References + + +## Description +Various references used in project. + + +## Python References +* Nested Functions - <https://realpython.com/inner-functions-what-are-they-good-for/> +* The "nonlocal" Keyword - <https://stackoverflow.com/a/8178808> + + +## Python 3rd Party Library + +### Python SDL2 Library References +* Official SDL2 Library Docs - <https://pysdl2.readthedocs.io/en/rel_0_9_7/tutorial/pong.html> +* Official SDL2 Library Examples - <https://github.com/marcusva/py-sdl2/tree/master/examples> +* Additional Repo of Various Examples - <https://github.com/caerus706/Python3-pySDL2-examples> +* Unfinished Random Tutorial, found via google searches - +<http://www.roguebasin.com/index.php/Complete_Roguelike_Tutorial,_using_python3%2Bpysdl2> +** Mostly used as reference in getting initial program logic setup. Cross-referencing examples can be helpful. +* Rendering Text, because there seem to be minimal good sources on it - +* <https://stackoverflow.com/questions/24709312/pysdl2-renderer-or-window-surface-for-handling-colors-and-text> + +### Networkx Library +* Official Networkx Library Docs - <https://networkx.org/documentation/stable/reference/index.html> + + diff --git a/readme.md b/readme.md index 13f55a90664f4807d1170a4951ee779538d8f16f..3dd1e505c8fc5ba7f4d575908320e4b216565e67 100644 --- a/readme.md +++ b/readme.md @@ -46,17 +46,5 @@ Any tiles on the outer edge of the grid MUST have a wall along the outer border. Lastly, window size can be adjusted via the (WINDOW_WIDTH, WINDOW_HEIGHT) variables at the top of main.py. -## Helper Documentation/Tutorials - -### SDL2 Library -* Official SDL2 Library Docs - <https://pysdl2.readthedocs.io/en/rel_0_9_7/tutorial/pong.html> -* Official SDL2 Library Examples - <https://github.com/marcusva/py-sdl2/tree/master/examples> -* Additional Repo of Various Examples - <https://github.com/caerus706/Python3-pySDL2-examples> -* Unfinished Random Tutorial, found via google searches - -<http://www.roguebasin.com/index.php/Complete_Roguelike_Tutorial,_using_python3%2Bpysdl2> -** Mostly used as reference in getting initial program logic setup. Cross-referencing examples can be helpful. -* Rendering Text, because there seem to be minimal good sources on it - -* <https://stackoverflow.com/questions/24709312/pysdl2-renderer-or-window-surface-for-handling-colors-and-text> - -### Networkx Library -* Official Networkx Library Docs - <https://networkx.org/documentation/stable/reference/index.html> +## References +See `documents/references.md`.