Marmalade-NG / marmalade-ng

Fork of Marmalade-V2
10 stars 2 forks source link

Simplify the interaction between NG and a new project by making Repl init process first and foremost in docs. #5

Open severian1778 opened 11 months ago

severian1778 commented 11 months ago

The documentation assumes a lot of knowledge and does not scale well from simple, to intermediate, to advanced. I suggest the following simlple additions to README

1) Explain the most simple and basic interaction with NG (mint) with minimal policies and assume users know nothing. Walk through it step by step starting with REPL enviorment creation and toward test-net and be very careful to explain everything that is going on. Perhaps a medium post.

The concepts are intimidating on first approach and establishing a "foothold" in working with NG would be a beneficial tool to the new user.

2) Explain how, in very simple and clear step by step sentences how to interface a module on testnet with NG. (maybe connected with 1) )

The production deployment is not simple enough. Again a user needs to gain a "foothold" to work wtih NG. There are suggestions in the "how to" documentation to simply -> (use marm-ng) but in most programming langauges you import 3rd party software into your module and so its confusing how to do this. How is this done? Do we send transactions to the marm-ng deployed SC on testnet only?

Thanks and sorry if the questions are stupid. Concepts are very nice, but the execution is most important.

severian1778 commented 11 months ago

UPDATE:

It took some time to find this:

https://github.com/CryptoPascal31/kadena_repl_sandbox/tree/856abef0d0dd35c724551da933f5559fb91c49f8

It might be useful to make this front and center on your docs.