search

psyinfra / HTCAnalyze

MIT License
0 stars 3 forks source link

overhaul README #102

Closed aqw closed 4 years ago

aqw commented 4 years ago

This lumps everything into one commit:

aqw commented 4 years ago

This is still in progress. I plan to finish up "Getting started" and "Examples".

codecov-io commented 4 years ago

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #102   +/-   ##
=======================================
  Coverage   76.63%   76.63%           
=======================================
  Files           4        4           
  Lines        1083     1083           
  Branches      266      266           
=======================================
  Hits          830      830           
  Misses        173      173           
  Partials       80       80

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 ca0e80f...0dfbc7d. Read the comment docs.

aqw commented 4 years ago

All of the sections have at least been touched. There's room for further improvements (especially with the example output of the modes), but this appreciably moves things forward and is a good stopping point while other issues are addressed.

Waiting on approval by @mathisloevenich

mathisloevenich commented 4 years ago

examples will be updated in a future PR regarding #107, after we have chosen a good way, to output the data.