search

vermaden / automount

Simple devd(8) based automounter for FreeBSD
66 stars 20 forks source link

Consider separating the change log from README #23

Closed grahamperrin closed 1 year ago

grahamperrin commented 3 years ago

From https://github.com/vermaden/automount/issues/22#issuecomment-771049089: 

% automount --help
automount: illegal option -- -
usage: automount [-D name=value][-o opts][-Lcfuv]
%

I ran automount --help because I saw it exemplified at the front page.

https://github.com/vermaden/automount/blob/bf899bcbd5ecd992bdea703197c10951f54bbd90/README#L245

vermaden commented 3 years ago

I wrote that README before /usr/sbin/automount existed :)

grahamperrin commented 3 years ago

I understand :-)

For newcomers, a short README (separated from the change log) could be better, including a brief hint on usage i.e.:

/usr/local/sbin/automount --help | less

I'm happy to do a PR but I hesitate because you might prefer to write changes yourself …

vermaden commented 3 years ago

I will update the README :)

vermaden commented 3 years ago

GitHub has the same problem. Generally when You want to write new comment anywhere - first hit [CTRL]+[F5] to refresh the page without using your local cache.

I updated the README.

Regards.