argos-research / documentation

argos research documentation project
https://argos-research.github.io/documentation
0 stars 2 forks source link

Install documentation #19

Open irgendwie opened 6 years ago

irgendwie commented 6 years ago

The Install documentation is lacking in several points.

I suggest we improve the points and additionally describe how to execute the whole setup in qemu (pbxa9) with an example application (not necessarily dom0-HW) in our operating-system/vagrant setup, since most students/we won't execute the whole setup with real hardware if they/we are just implementing small features.

privatereese commented 6 years ago

I think a separate "getting started" description would be good and all the other stuff should be divided into pieces for their use case.

Three main setups:

Our documentation just features the second point and is only useful for ourselves. We have to focus the documentation to a developers view.

Therefore we need:

So first and very urgent would be to rewrite the documentation to support developers which want to write new code. As a first basis a generell documentation of the steps would be good until a point where steps differ depending on the project or subproblem which is being worked on.