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

Rewrite the README.md file #9

Closed
miha42-github opened this issue Oct 13, 2022 · 1 comment · Fixed by #16
Closed

Rewrite the README.md file #9

miha42-github opened this issue Oct 13, 2022 · 1 comment · Fixed by #16
Assignees
Labels
enhancement New feature or request

Comments

@miha42-github
Copy link
Owner

The README.md file doesn't reflect the current state of the service and needs to be improved. The major focus will be on the installation and startup process. Additionally, the overall motivation section, status, etc. needs to be updated to reflect the change in strategy. We will reuse as much as possible and add appropriate screenshots to enrich the documentation. We can and should also consider bringing links to the documentation so users can see an example in action.

@miha42-github miha42-github added the enhancement New feature or request label Oct 13, 2022
@miha42-github miha42-github self-assigned this Oct 13, 2022
@miha42-github
Copy link
Owner Author

miha42-github commented Oct 17, 2022

Base file rewritten, some minor changes remain to pursue:

  • Update dependencies
  • Add code contribution section
  • Add issues section

After these are completed then we will declare this issue closed.

@miha42-github miha42-github linked a pull request Oct 17, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant