Documentation Improvement: Clarify Docker Usage for Different Shells

[flamewalker103-commits]

Overview

The README provides a good introduction to using EvoMaster with Docker, specifically highlighting the command to fuzz the PetClinic example API. However, there seems to be a crucial point regarding shell compatibility that could be clearer for users, particularly Windows users.

Suggested Improvement

• Expand the section where the command is given to explicitly address potential issues users might face when running the command in various shell environments. Currently, it mentions MSYS shell and suggests an adjustment for that specific case, but it would be beneficial to include details for other common environments (e.g., Command Prompt, PowerShell).

• Consider adding a troubleshooting section that discusses common errors related to Docker commands, especially for users who might be less familiar with command-line interfaces.

Example Addition to README

### Using Docker on Different Shells

When running the EvoMaster Docker command in different shell environments, you may need to adjust the command syntax. 

- **MSYS Shell (e.g., Git Bash)**: Add an extra `/` before `$`:  
  ```bash
  docker run -v "$(pwd)/generated_tests":/generated_tests webfuzzing/evomaster --blackBox true --maxTime 30s --ratePerMinute 60 --bbSwaggerUrl https://petstore.swagger.io/v2/swagger.json

• Command Prompt: The syntax remains the same, but ensure that Docker is installed and running, and check for permission issues.
• PowerShell: You might need to adjust the path syntax accordingly, for example:

  docker run -v "${PWD}/generated_tests:/generated_tests" webfuzzing/evomaster --blackBox true --maxTime 30s --ratePerMinute 60 --bbSwaggerUrl https://petstore.swagger.io/v2/swagger.json

Troubleshooting

If you encounter issues running the command:

• Ensure Docker is installed and running.
• Check that you have permission to mount the specified volume.
• Consult the Docker documentation for your shell environment for specific syntax requirements.

[arcuri82]

hi @flamewalker103-commits

thanks for the suggestion! I updated the documentation to reflect your feedback.

Is it more clear now?

Feel free to comment on any other part of the documentation that you find either ambiguous or in need of more details

thanks!