UTBotCpp icon indicating copy to clipboard operation
UTBotCpp copied to clipboard

Update readme for the project

Open orchestr7 opened this issue 4 years ago • 2 comments

The existing documentation is very limited… I would like to get more information from it 🙏

orchestr7 avatar Nov 20 '21 06:11 orchestr7

@akuleshov7 we made readme bigger. Do you have some particular suggestions?

korifey avatar Dec 08 '21 16:12 korifey

I suggest to add:

  • labels to the readme (with version, CI/CD result, etc)
  • information about the latest version (at least the number with the link to the release)
  • add links where I can download and install assets (I was not able to find them in releases)
  • list with the supported OS can be moved to a separate section
  • a little bit restructure the Readme, plain text is not so readable by opensource users

orchestr7 avatar Dec 08 '21 16:12 orchestr7