Update the documentation

yegor256 / cam

Classes and Metriсs (CaM): a dataset of Java classes from public open-source GitHub repositories

http://cam.yegor256.com

MIT License

25 stars 39 forks source link

Update the documentation #372

Closed nai1ka closed 2 months ago

nai1ka commented 2 months ago

Added a new "Troubleshooting" section to document known issues. This includes details about the issue discussed here.

@yegor256, what do you think, is it an appropriate way to document this kind of info in the "Troubleshooting" section?

yegor256 commented 2 months ago

@nai1ka maybe we can check the version of make somehow automatically and print a proper error message to the user? Instead of explaining the problem in the README.

nai1ka commented 2 months ago

@yegor256, I agree, it's better this way. Done.

yegor256 commented 2 months ago

@nai1ka thanks!