Essentially the idea is to communicate the main benefit of DRF upfront in the Readme.
I've had a conversation with some other guys and I explained the projects to them. The only question I've got was: "Great but what's the use of it?"
Apparently, it is not that obvious as I thought. Therefore I've made a new version of the Readme file stating first the benefit, second how to use it and third "all the rest".
The three core properties "fast to program", "simple / efficient" and "easy to maintain" aren't my ideas but I've read them on the blog of Twitters head of engineering about three qualities a project "must have" in order to be used daily. I tend to agree by now since time is valuable and things have to work out of the box in order to be useful. That's exactly what the Readme should communicate: "It just works!"
@MartinSenne please Review:
Essentially the idea is to communicate the main benefit of DRF upfront in the Readme.
I've had a conversation with some other guys and I explained the projects to them. The only question I've got was: "Great but what's the use of it?"
Apparently, it is not that obvious as I thought. Therefore I've made a new version of the Readme file stating first the benefit, second how to use it and third "all the rest".
The three core properties "fast to program", "simple / efficient" and "easy to maintain" aren't my ideas but I've read them on the blog of Twitters head of engineering about three qualities a project "must have" in order to be used daily. I tend to agree by now since time is valuable and things have to work out of the box in order to be useful. That's exactly what the Readme should communicate: "It just works!"