Outdated README including build/setup instructions

[Malyuk-A]

Short

The README.md (especially in the oakestra-net/node-net-manager) is outdated, thus faulty. If you try to follow it to build/install/setup things it will eventually fail.

Proposal

Bring the README up to date, and or migrate it to the new OAK Docs entirely. Currently it does confuse more than it helps IMO.

A few examples:

• Under the "Structure" header, a "install.sh" is mentioned, however it is no longer there - it is the build folder instead.
• The install.sh (in the build folder) makes a lot of assumptions, e.g. where the user calls this script from (without any comment about where it should be invoked from), the tuncfg.json and netcfg.json are files that are (AFAIK) only acquired when installing the main OAK repo and fetching the NetManaget/NodeEngine resources - i.e. these two files are "magic-files" that are not part of the repo, especially not the build folder
• etc.

Without the help of @smnzlnsk I would not have been able to build this - without reinventing the wheel.
He mentioned that he uses a custom makefile for this, so no one currently seems to be using these build instructions.

Solution

Bring these instructions up to date and or migrate them to the upcoming OAK Docs/Wiki.

Status

This ticket is there to inform others about the current state of things.

Checklist

• Discussed
• Solved
• Tested

[Malyuk-A]

Also on a related note maybe - @smnzlnsk & I also discussed the structure of this repo in general.

We find it a bit strange that the NetManager is a folder inside the oakestra-net repo, "wrapped" in code that could/should arguably be part of the main-repo.

One thing we discussed is migrating these Python components to the main repo and only keeping the NetManager repo here and including it as a submodule in the main repo - Which could improve comprehension and building/starting things up.