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

Document the project #3

Closed
Jarmos-san opened this issue Sep 16, 2024 · 0 comments · Fixed by #8
Closed

Document the project #3

Jarmos-san opened this issue Sep 16, 2024 · 0 comments · Fixed by #8
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Jarmos-san
Copy link
Member

Jarmos-san commented Sep 16, 2024

The documentation for the project is not good enough and requires further polishing. The following information will have to be documented and stated properly:

  1. Document all the Operating Systems the script is supported on.
  2. State the system architectures which are supported (by default and through configurations).
  3. Provide disclaimer about security concerns when running the script with root privileges and so on (see Handle script's execution to block when running with root privileges #2 for some reference).
  4. Specify how invoking the script multiple times will spin up n number more runners on top of the already existing ones.
@Jarmos-san Jarmos-san added the documentation Improvements or additions to documentation label Sep 16, 2024
@Jarmos-san Jarmos-san self-assigned this Sep 16, 2024
@Jarmos-san Jarmos-san linked a pull request Sep 19, 2024 that will close this issue
Jarmos-san added a commit that referenced this issue Sep 19, 2024
This PR updates the README and adds some disclaimer about using the
script(s).

Fixes #3

Co-authored-by: Somraj Saha <somraj.saha@jarmos.dev>
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 a pull request may close this issue.

1 participant