Added README

.gitignore

@@ -1 +1,2 @@
-__pycache__/*
+__pycache__
+env

README

@@ -0,0 +1,86 @@
+# 2d-truck-simulator
+
+Simple overview of use/purpose.
+This simulator was designed with the purpose to develop and run tragectory planning
+algorithms for vehicles, specifically trucks with trailers. It feature connectors
+(bindings) to ROS2 (Humble) as well as visualization that can be turned off.
+
+## Description
+
+An in-depth paragraph about your project and overview of use.
+The simulator was created with the goal of developing and running tragectory planning
+algorithms. It features basic sensor and controls that would be required for these
+topics.
+
+## Getting Started
+
+### Dependencies
+
+* Python3.12
+* Pip
+* Python virtual enviroment
+* ROS2 Humble
+
+For Ubuntu24.04 the following package is also required: libxcb-xinerama0
+
+The python dependacies can be installed with:
+```
+sudo apt install python3-pip python3.12-venv
+```
+
+For ROS Humble follow the official instalation (optional). https://docs.ros.org/en/humble/index.html
+
+### Installing
+
+The following python packages are required:
+```
+python3 -m venv env
+source env/bin/activate
+pip3 install -r requirements.txt
+```
+
+* How/where to download your program
+* Any modifications needed to be made to files/folders
+
+### Executing program
+
+* How to run the program
+* Step-by-step bullets
+```
+code blocks for commands
+```
+
+## Help
+
+Any advise for common problems or issues.
+```
+command to run if program contains helper info
+```
+
+## Authors
+
+Contributors names and contact info
+
+ex. Dominique Pizzie  
+ex. [@DomPizzie](https://twitter.com/dompizzie)
+
+## Version History
+
+* 0.2
+    * Various bug fixes and optimizations
+    * See [commit change]() or See [release history]()
+* 0.1
+    * Initial Release
+
+## License
+
+This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details
+
+## Acknowledgments
+
+Inspiration, code snippets, etc.
+* [awesome-readme](https://github.com/matiassingers/awesome-readme)
+* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
+* [dbader](https://github.com/dbader/readme-template)
+* [zenorocha](https://gist.github.com/zenorocha/4526327)
+* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46)

requirements.txt

@@ -0,0 +1,2 @@
+PyQt5
+pyyaml