lewdlime / abcm2ps

abcm2ps is a command line program which converts ABC to music sheet in PostScript or SVG format. It is an extension of abc2ps which may handle many voices per staff. abcm2ps is Copyright © 2014-2016 Jean-Francois Moine.
http://moinejf.free.fr/
GNU General Public License v3.0
82 stars 31 forks source link

documentation updates #32

Closed olets closed 6 years ago

olets commented 6 years ago

Hi Jef, here are some minor update suggestions for README and INSTALL. Not sure you'll like them all, so I broke them into commits to help you determine what to keep. If you don't like any just ignore this :)

The first is adding build instructions to the readme — new users, especially people used to simply downloading a binary, might look at INSTALL and decide it was too complicated. (When I read it now, it's straight forward. But I remember how confusing it was to me years ago.)

The second adds your name to the readme. It would be easy to not see your name in the Github page description, and anyway that description isn't included in the repo.

The third follows the formatting convention I usually see for Markdown: letting the viewer app handle line breaks. Also puts the ABC Standard link on the same line as the preceding text, matching the formatting of Documentation and Links.

The last clarifies what "MAC" in INSTALL means, and points Mac and Windows users towards PS viewers.

moinejf commented 6 years ago

Well, I am OK with the 1st and 4rd updates.
About the 2nd, my name appears in all source files. Only this is important.
About the 3rd, I am using an old terminal text editor (micro-emacs version 2) which truncates the lines greater than the terminal width. Also, I find easier to read texts when the line width is small enough. That's why I set the geometry of my terminals to 90x32, and, so, their width is quite the same as the one of a sheet.