polkavm icon indicating copy to clipboard operation
polkavm copied to clipboard

Getting started documentation

Open jangorecki opened this issue 1 year ago • 3 comments

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.

jangorecki avatar Sep 03 '24 09:09 jangorecki

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.

hitchhooker avatar Sep 03 '24 17:09 hitchhooker

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

athei avatar Sep 05 '24 08:09 athei

@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 avatar Sep 05 '24 11:09 jangorecki