Integrate more of the README.md into the sphinx site

Open-Agriculture / AgIsoStack-plus-plus

AgIsoStack++ is the completely free open-source C++ ISOBUS library for everyone

https://agisostack.com/

MIT License

187 stars 41 forks source link

Integrate more of the README.md into the sphinx site #397

Closed GwnDaan closed 9 months ago

GwnDaan commented 9 months ago

Moved some of the more use case specific stuff from the main README, to the sphinx site to not overwhelm a first time viewer. While still allowing more detailed instructions in a central place on the site.

I think adding the quick links and a catch phrase also looks nice at the top of our README, but I'd like thoughts on that. Replacing the 3 top images with a catchy demonstration video might be cool in the future? 🤔

View modified readme here

GwnDaan commented 9 months ago

Oh I also removed the minimum coverage and maximum duplication conditions from the sonar quality gate, a bit more of the positive green checks didn't sound too bad to me :). We'll still see the coverage and duplication percentage in the overview posted by the bot

sonarcloud[bot] commented 9 months ago

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud