search

srobo / competition-simulator

A simulator for Student Robotics Virtual Competitions
https://studentrobotics.org/docs/simulator/
MIT License
8 stars 2 forks source link

Improve setup docs #408

Open PeterJCLaw opened 10 months ago

PeterJCLaw commented 10 months ago

In SR2023 several teams apparently struggled to set up the simulator for use. If we can make the process easier that would be great, though likely the best we can do (for SR2024) is document it better.

A good approach here is probably to start with a clean machine (maybe a VM?) and follow the setup instructions directly to validate that they cover everything. If we can get someone not already familiar with the simulator (or, better, with programming) to help with the testing that would be great.

PeterJCLaw commented 10 months ago

@8BitJosh as this suggestion came from you - do you have any details of specific issues which competitors hit in SR2023 which we should address?

8BitJosh commented 10 months ago

Should go through the full setup process and use images/videos to explain the process. We should look at any steps that may be confusing to improve how it is setup.

Also I had feedback from competritors that they found it difficult to undestand the text based file tree.