SuperblocksHQ / ethereum-studio

Official Ethereum Studio project repository. And IDE specially tailored to make it as simple as possible to onboard new users into the Ethereum ecosystem
https://ethereum.org/build/
GNU General Public License v3.0
186 stars 103 forks source link

Update Hello World template [Fixes #234] #235

Closed samajammin closed 4 years ago

samajammin commented 4 years ago

Description of the Change

Refactored the Hello World template (primarily the README) based on the extensive feedback we received from a group of Ethereum developers.

Alternate Designs

See #234

Benefits

See #234

Possible Drawbacks

Users must go to the project files to read the code vs. the README, however, that's intended & based on the feedback we received will improve UX.

Verification Process

Ran the project locally.

Github Issues

234

samajammin commented 4 years ago

I welcome input from anyone on this!

I highly recommend running the project locally & using the template. It's much easier to grok the new instructions & flow vs. reading the file changes on Github.

samajammin commented 4 years ago

Thanks for the review @ChrisChinchilla! I incorporated all your suggested changes.

I'd also like to try running through it myself to see if it makes sense when following the application code.

Sure thing, that's what I recommended 😄 .

And… I think it makes sense to re-record the video based around this, so I can test that it makes sense as I do that.

Perhaps but how long does a video take to record? We potentially have a series of upcoming changes to Ethereum Studio (see all the open issues), I would like to avoid you having to re-record a bunch of times. I suggest we hold off on that for now.

samajammin commented 4 years ago

Thanks for the review @javier-tarazaga. @ChrisChinchilla I'll wait for another review from you before merging anything.