mlpack / models

models built with mlpack
https://models.mlpack.org/docs
BSD 3-Clause "New" or "Revised" License
35 stars 41 forks source link

Clean up the README #2

Closed rcurtin closed 4 years ago

rcurtin commented 4 years ago

I've made some basic changes here to the README that hopefully highlight what this repository is now for, and also there are a number of comments inline that point out the things that still need to be addressed.

mlpack-bot[bot] commented 4 years ago

Thanks for opening your first pull request in this repository! Someone will review it when they have a chance. In the mean time, please be sure that you've handled the following things, to make the review process quicker and easier:

Thank you again for your contributions! :+1:

birm commented 4 years ago

Have you considered using markdown comments

 [//]: # "such as this"

for some of the sections?

rcurtin commented 4 years ago

That's true, but I wanted the comments to be visible so that we didn't forget about them since they don't display on the repo main page. :smile: Also it gives us good motivation to resolve them relatively quickly! :)