Build documentation hopelessly outdated on master

[mpreisler]

Description of Problem:

Master is built using cmake but there are tons of mentions of autogen, automake, etc... still in master. All the docs need to be updated.

Furthermore, Windows is considered second citizen platform (there is a special chapter for it and it says "openscap can also be built on windows...") which is not the case any-more. The README assumes you are using Linux and has no mention of Windows or OSX. We need to restructure the docs to support Linux, MacOS X and Windows builds equally.

I am mainly talking about docs/manual/manual.adoc and README here but please... grep the whole repo when fixing this.

OpenSCAP Version:

git show
commit 0f648dc2d6efe90b9519a333dd25de697c008f1d (HEAD -> python2_disabled_if_not_found, upstream/master, master)
Merge: 5fdc2ad78 9239c06b5
Author: Watson Yuuma Sato <wsato@redhat.com>
Date:   Fri Jun 15 13:26:29 2018 +0200

    Merge pull request #1050 from cipherboy/rm-oval-probe-dir

    Remove occurrences of OVAL_PROBE_DIR in master

Operating System & Version:

Vokna 10

[jan-cerny]

Great catch! @mpreisler Thank you very much for opening this problem.

I have a long-term idea that is related to this problem:

I don't like 2 things:

1. The Developers operation section is a part of Users manual. Developers and Users are 2 different groups of people. Users might not be interested in compilation. Also, it might not be expected for developers to look for this type of information at Users manual.
2. Compilation is described at 2 places - README and Users manual, which means we need to maintain it twice.

I suggest creating a document called "Developers Manual" which would describe everything regarding compilation on all platforms. I suggest moving the related text from Users manual to Developers manual. I suggest linking this new document from README.

[mpreisler]

I agree with your approach. I'd maybe suggest that users might be interested in how to compile as well. Especially on Linux platforms users are often expected to compile their packages.

[jan-cerny]

@mpreisler Where do you think would be the best place for this information then?

[jan-cerny]

@mpreisler Could it be something like #1080 ?

[matejak]

Closed by #1080