add version and a license

[bonidier]

Hi @denouche,

I think the script need a version number, printed with --version and/or -V options
I can do this one, but you choose the version number.

You should also add a LICENSE file to this project

Regards

[denouche]

Hi!

Yes, I should have done that a long time ago.
I will take some time to do that soon.

Thank you

[denouche]

Did you already addressed (for example on others projects) all these points (versioning, changelog, packaging), and have some tips? I never did that for a shell script but these issues are very interesting (I'm used to these problematics but for API or frontend projects).

For versioning I found thing like https://github.com/fsaintjacques/semver-tool

Then if we want to go up to the packaging maybe we could generate the changelog from commit messages, with something like https://manpages.debian.org/jessie/git-buildpackage/git-dch.1.en.html ?

And for packaging I found this article http://www.krakend.io/blog/automating-linux-packaging/
based on https://github.com/jordansissel/fpm which seems to be interesting.

You already mentioned working on packaging in another PR, so for now I will take a look to the license, versioning and submit you some PR.

[bonidier]

Hi Antoine!

License file
You should follow the Github help, there is templates :
https://help.github.com/articles/adding-a-license-to-a-repository/

versioning
using the semver practices with the format MAJOR.MINOR.PATCH should be enough,

for a first release, I suggest to start with version 0.0.1 or 0.1.0

CHANGELOG file

I prefer to add the main changes with explicit sentences by myself,
instead of a generating a strange content with a bunch of unordered/useless info from commit log like 'updated README... updated README...".

I play with markdown in that way : http://keepachangelog.com/en/1.0.0/

Packaging
Yeah, it's better to play with it later, out of this issue.
Each packager has its own practice to build that.
It may be a complex environment to prepare, out of this script purpose.

I know RPM format, and my idea is only to add the definition file,
and let regular users to build it with their daily tools.

Cheers!