-
Notifications
You must be signed in to change notification settings - Fork 11
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
docs: add readme #38
docs: add readme #38
Conversation
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
What I feel is missing:
I will try to follow the README with a clean VM |
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr>
+ rename section "Go to the project directory" to "Setup" + add a command that generates config.toml + remove unneeded space in code block + use alerts markdown Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr>
Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr>
I have added some docs and I have tried from scratch on a Debian, it works if we follow the instructions (also, the project needs ~5GB of space lol) |
Maybe you should mention how to compile a kernel and build a rootfs ? |
This process is automatically done by when handling a request |
Great work ! |
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net>
* docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com>
* Feat: add initramfs implementation for vmm (#34) * feat(vmm): implemented automatic generation of rootfs with initramfs Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * feat: image generation based off language Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * feat(vmm): implemented automatic generation of rootfs with initramfs Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * fix(vmm): fix logging & language order Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * feat(vmm): one image per language Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * feat(vmm): implemented initramfs Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * fix(vmm): code cleanup Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * fix(vmm): code cleanup Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * fix(vmm): code cleanup Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> * fix: rust export for cargo agent and increase MMIO_GAP_END Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> * chore: lint Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> * fix: add back tracing Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Co-authored-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * feat: shutdown vm Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * docs: add readme (#38) * docs: add readme Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> --------- Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * remove(vmm): useless crate Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * fix: lint Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * fix: fmt Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> * fix: lint Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> --------- Signed-off-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr> Signed-off-by: Font Vincent <vincent.font@etu.umontpellier.fr> Signed-off-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Muriel Paraire <72733662+MurielParaire@users.noreply.github.com> Co-authored-by: Mauran <thomas.mauran@etu.umontpellier.fr> Co-authored-by: Thomas Mauran <78204354+thomas-mauran@users.noreply.github.com> Co-authored-by: Matéo Fernandez <mateo.fernandez@etu.umontpellier.fr> Co-authored-by: Alexandre Sollier <github@kuruyia.net>
What does this pr do
This pr adds a basic README with the installation information.