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 & CONTRIBUTION documenation #48

Open
bchalios opened this issue Aug 19, 2021 · 0 comments
Open

Add README & CONTRIBUTION documenation #48

bchalios opened this issue Aug 19, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@bchalios
Copy link
Contributor

We should add a README file on how to use vAccel and a contribution guide with all the processes that need to be followed in order to contribute to vAccel, both for internal and external use.

Component(s) that need(s) improvement

  1. vaccel
  2. Maybe at this point we should add the equivalent files to sub-modules (?)

Describe the improvement

We mainly need a README file that describes how vAccel can be used end to end. This would include building vAccel or downloading a particular version of it and setting up the environment for running an end-to-end example.

We also need a contributor's guide to use as a reference for our internal development and (hopefully) external contributions.

I will update this issue as I have a more concrete idea of the structure of the documents with TODOs

@bchalios bchalios added the enhancement New feature or request label Aug 19, 2021
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

No branches or pull requests

1 participant