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.

Sign up for GitHub

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

Jump to bottom

INSTALL.md #79

Open
5 tasks
Arthi-chaud opened this issue May 11, 2024 · 0 comments
Open
5 tasks

INSTALL.md #79

Arthi-chaud opened this issue May 11, 2024 · 0 comments
Assignees
@Arthi-chaud
Labels
documentation Improvements or additions to documentation
Milestone
v0.3

Comments

@Arthi-chaud
Copy link
Owner

There should be an INSTALL.md file at the root of the repository. It should:

  • Explain how to use the scanner.json file

  • Explain how to use the docker-compose.yml and nginx.* files

  • Explain how to use the .env file

    • Link back to Kyoo for Transcoder HW acceleration

  • Reference that INSTALL.md in the root README.md
@Arthi-chaud Arthi-chaud added the documentation Improvements or additions to documentation label May 11, 2024
@Arthi-chaud Arthi-chaud added this to the v0.2 milestone May 11, 2024
@Arthi-chaud Arthi-chaud self-assigned this May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Arthi-chaud Arthi-chaud

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.3
Development

No branches or pull requests
1 participant
@Arthi-chaud