kimtore / pms

Practical Music Search is an interactive Vim-like console client for the Music Player Daemon.

https://ambientsound.github.io/pms/

MIT License

249 stars 23 forks source link

Improve documentation #100

Closed tremby closed 6 years ago

tremby commented 7 years ago

I've based this atop my other two changesets from today. Let me know if you want me to separate it out.

Among stylistic changes, additions of a lot of descriptions, and some reorganizing, some undocumented commands have been added.

kimtore commented 7 years ago

Needs rebase after #96 was merged.

tremby commented 6 years ago

Rebased.

tremby commented 6 years ago

I can switch the order of this and #98 if you prefer.

kimtore commented 6 years ago

Awesome improvement to the documentation, and highly appreciated.

Yes, it would be beneficial to rearrange the order, this can be merged right away as long as the new viewport commands in #98 are moved to that PR.

tremby commented 6 years ago

OK, this one is now directly on top of current master.

codecov-io commented 6 years ago

Codecov Report

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

@@           Coverage Diff           @@
##           master     #100   +/-   ##
=======================================
  Coverage   53.81%   53.81%           
=======================================
  Files          51       51           
  Lines        1797     1797           
=======================================
  Hits          967      967           
  Misses        807      807           
  Partials       23       23

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 e2d2e50...673def0. Read the comment docs.

tremby commented 6 years ago

Just changed this a little since it's clear you prefer the * style of lists in markdown rather than the - style.