Signed-off-by: Vipul Gupta (@vipulgupta2048) vipulgupta2048@gmail.com
@swarnimarun @Sc0rpi0n101 Major overhaul done to README, check it out. Some points to consider.
Code snippets look better, read better and are easily copied when done like this
$ I am awesome code to be copied
than
I am code to be copied in between a mountain of texts
Whosoever wrote instructions for writers, check out the points to Important Notes
I have added some cool new badges to for the README, let me know what you think.
Whosoever wrote installation instructions, was probably too enthusiastic on Markdown headings. I removed the clutter and placed it in its own file.
This would need to be reviewed quite a lot, as hyperlinks are going everywhere. Let me know what I missed. I think, with this, we are quite close for our first release.
@rohanvtk I have changed LICENSE to head under ALiAS. According to goody 'ol Open-Source culture, we always notify the owners of the license about any change. And here's me following the same.
I think one should always focus on writing the best docs that they possibly can. I was taught the same through OSS and my professional experience, I would love if you follow the same in your own development work.
@Kaushl2208 @thisisayush @aniketmaithani @bhanuvrat - Views on the blog, and anything more.
Signed-off-by: Vipul Gupta (@vipulgupta2048) vipulgupta2048@gmail.com @swarnimarun @Sc0rpi0n101 Major overhaul done to README, check it out. Some points to consider.
Code snippets look better, read better and are easily copied when done like this
than
I am code to be copied in between a mountain of texts
Whosoever wrote instructions for writers, check out the points to Important Notes
I have added some cool new badges to for the README, let me know what you think.
Whosoever wrote installation instructions, was probably too enthusiastic on Markdown headings. I removed the clutter and placed it in its own file.
This would need to be reviewed quite a lot, as hyperlinks are going everywhere. Let me know what I missed. I think, with this, we are quite close for our first release.
@rohanvtk I have changed LICENSE to head under ALiAS. According to goody 'ol Open-Source culture, we always notify the owners of the license about any change. And here's me following the same.
I think one should always focus on writing the best docs that they possibly can. I was taught the same through OSS and my professional experience, I would love if you follow the same in your own development work.
@Kaushl2208 @thisisayush @aniketmaithani @bhanuvrat - Views on the blog, and anything more.