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

More readable README #25

Closed
DvaMishkiLapa opened this issue Nov 21, 2024 · 1 comment
Closed

More readable README #25

DvaMishkiLapa opened this issue Nov 21, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@DvaMishkiLapa
Copy link
Owner

No matter how many READMEs I write, I always end up with a book about technical details.

Here's something that would probably improve the situation:

  • We need to think about how we can merge the support tables for different OSes (after PR Adding Linux support #24);
  • It might be worth making some .md documents:
    • Main (header, general description, support info, links to other documents, acknowledgements);
    • For building;
    • Configuration descriptions.

We need to quickly explain to the user the basics of how to run Client and Server. VPK installation is unlikely to be a problem, people will mostly come via VitaDB. They will get the client files from the repository page, as they are not in VitaDB.

@DvaMishkiLapa DvaMishkiLapa added the documentation Improvements or additions to documentation label Nov 21, 2024
@DvaMishkiLapa DvaMishkiLapa self-assigned this Nov 21, 2024
@DvaMishkiLapa
Copy link
Owner Author

Closed in #26

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

1 participant