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

Add readme #35

Open
ruansp opened this issue Oct 17, 2023 · 3 comments
Open

Add readme #35

ruansp opened this issue Oct 17, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ruansp
Copy link
Collaborator

ruansp commented Oct 17, 2023

Please add a readme if have time.

@ruansp ruansp added the documentation Improvements or additions to documentation label Oct 17, 2023
@lily983
Copy link
Owner

lily983 commented Oct 17, 2023

Ok, will do it. Shall we make it a public repo after adding readme?

@ruansp
Copy link
Collaborator Author

ruansp commented Oct 17, 2023

For public, might need:

  • Detailed readme for installation and execution
  • API documentation
  • Docker environment
  • Github Action for continuous integration (CI)
  • Demos for all the tasks

@lily983
Copy link
Owner

lily983 commented Oct 17, 2023

Thank you for the detailed information. Will add them and change the repo name.

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

No branches or pull requests

2 participants