adswa commented 5 years ago

I'm in favor of providing users with information on the algorithm and its usage to get them ready to go in the README. I've extended the README to include a "minimal working example" command line call, copied the optional parameter descriptions from the manuscript with a note on how they could be used, and copied a bit of the abstract as a general description.

In the future, we might want to link the publication/citation as well I suppose.

Tagging @mih

codecov-io commented 5 years ago

Codecov Report

Merging #8 into master will not change coverage. The diff coverage is n/a.

@@          Coverage Diff           @@
##           master      #8   +/-   ##
======================================
  Coverage    86.9%   86.9%           
======================================
  Files           8       8           
  Lines         695     695           
======================================
  Hits          604     604           
  Misses         91      91

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 113c1d8...2676d42. Read the comment docs.

mih commented 5 years ago

Cool, thx!

psychoinformatics-de / remodnav

Update README with description and example usage. #8

Codecov Report