Provide more documentation and a manpage

[arnaudquette-eaton]

One thing missing, and also compared to alien, is additional documentation and a manpage.

xenomorph misses the base build instructions (and for RUST newcomers like me, it's an issue :D) and usage instructions too.

README.md and xenomorph -h output are already great bases.
alien' manpage can be used as a good complement.
markdown format can be used with cargo mandown.

My proposal is to rewrite README.md to make it more complete, and eligible to mandown conversion for a real manpage and more complete xenomorph documentation.

Note: the remaining issue is that, to be fully manpage ready, README.md would look like

NAME

xenomorph - Shapeshift between package formats

SYNOPSIS

xenomorph [options] file [...]
...

DESCRIPTION

A tool that converts
....

[pluiedev]

I mean, the compile instructions are literally cargo build --release. It's not rocket science...

Also, I don't like having the README be structured like a man page. It's simply too rigid for what's supposed to be a simple introductory file.

[arnaudquette-eaton]

for RUST newcomers like me, cargo build --release (and the toolchain setup) was a small challenge :)
along with few RUST tricks that I had to learn... I'll post some notes.

I'm also not in favor of the manpage structure for the README, I'll check to PoC something.

I hope you appreciate my feedback, and support. I feel not, but I may be wrong :D

[arnaudquette-eaton]

see

• https://github.com/aquette/xenomorph/tree/work/docman
• main...aquette:xenomorph:work/docman

I'll also go for https://www.gnu.org/software/help2man/ for generating the manpage.
see attachment
xenomorph.1.txt

Possibly with few additions.