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

Getting started documentation #163

Open
jangorecki opened this issue Sep 3, 2024 · 3 comments · May be fixed by #164
Open

Getting started documentation #163

jangorecki opened this issue Sep 3, 2024 · 3 comments · May be fixed by #164

Comments

@jangorecki
Copy link

I would like to request to extend readme for essential information on how to get started, especially for devs who don't have much experience with alternative computer architectures.

  • how to setup development environment on fresh debian / fedora
  • reproducible example on how to code and compile to pvm binary
  • reproducible example on how to use compiled binary via pvm

I believe that would unlock access to this interesting project for many new developers.

@hitchhooker
Copy link

hitchhooker commented Sep 3, 2024

onboarding inexperienced devs come with support burden as well. its really not that hard to read .github/workflows file and execute scripts to install environment and then just play around with the repositories host /guest examples and polkatool.

best getting started readme is probably initial post at polkadot forums:

I wrote a game of life example some time ago and recommend doing similar easy task to get familiar with it.

@athei
Copy link
Member

athei commented Sep 5, 2024

As of right now this is also simply not a priority as this is not a user facing component in our software stack.

@jangorecki
Copy link
Author

jangorecki commented Sep 5, 2024

@hitchhooker Thanks for links, always good to have more examples.
Regarding support burden, it is not really good excuse to not improve documentation. Already having "issues" in a public project on github comes with support burden. If you give one hand, it doesn't mean you are obliged to give another. So having getting started section does not imply you need to guide inexperienced devs any further.

@athei polkavm probably will never be really user facing component. BTW. your talk I seen youtube on topic of PVM was very well made, thanks.

As I figured out minimal "getting started" process I will proceed with PR to resolve my request.

jangorecki added a commit to jangorecki/polkavm that referenced this issue Sep 5, 2024
@jangorecki jangorecki linked a pull request Sep 5, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants