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

docs: add readme #38

Merged
merged 9 commits into from
May 2, 2024
Merged

docs: add readme #38

merged 9 commits into from
May 2, 2024

Conversation

thomas-mauran
Copy link
Contributor

@thomas-mauran thomas-mauran commented May 1, 2024

What does this pr do

This pr adds a basic README with the installation information.

Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
@thomas-mauran thomas-mauran added the documentation Improvements or additions to documentation label May 1, 2024
@thomas-mauran thomas-mauran self-assigned this May 1, 2024
@mfernd
Copy link
Contributor

mfernd commented May 1, 2024

What I feel is missing:

  • "requirements" section to build the project
  • architecture diagram?
  • config path for CHANGEME

I will try to follow the README with a clean VM

thomas-mauran and others added 4 commits May 1, 2024 23:31
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>
@mfernd
Copy link
Contributor

mfernd commented May 2, 2024

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)

@mmoreiradj
Copy link
Contributor

Maybe you should mention how to compile a kernel and build a rootfs ?

@thomas-mauran
Copy link
Contributor Author

Maybe you should mention how to compile a kernel and build a rootfs ?

This process is automatically done by when handling a request

@MurielParaire
Copy link
Contributor

Great work !
But maybe specify the arguments of the config file ? Like which languages are supported, what the difference is between Run, PrepareAndRun and Prepare etc ?

Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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>
@thomas-mauran thomas-mauran merged commit b0bdf44 into virt-do:main May 2, 2024
2 checks passed
Hunh0w pushed a commit that referenced this pull request May 2, 2024
* 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>
Hunh0w pushed a commit that referenced this pull request May 2, 2024
* 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>
Hunh0w pushed a commit that referenced this pull request May 2, 2024
* 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>
MurielParaire pushed a commit to MurielParaire/cloudlet that referenced this pull request May 2, 2024
* 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>
remi-espie pushed a commit to remi-espie/cloudlet that referenced this pull request May 3, 2024
* 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>
MurielParaire pushed a commit to MurielParaire/cloudlet that referenced this pull request May 3, 2024
* 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>
MurielParaire added a commit that referenced this pull request May 3, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants