Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install documentation #19

Open
irgendwie opened this issue Nov 28, 2017 · 1 comment
Open

Install documentation #19

irgendwie opened this issue Nov 28, 2017 · 1 comment
Assignees

Comments

@irgendwie
Copy link
Member

The Install documentation is lacking in several points.

  • The documentation is more or less just a collection of bash scripts.
  • The documentation seems to not be current anymore at parts
  • ...

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
Copy link
Member

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:

  • Main setup at the hair (internal docu)
  • Main setting for developer to build some features (scripts/vagrant/ litte docu)
  • Main setup to rebuild as expected ( mostly how we think a whole setup should work)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants