docs: add readme

[GCdePaula]

No description provided.

[guidanoli]

offchain ➡️ off-chain
onchain ➡️ on-chain

[claudioantonio]

It is good to me, after considering Guilherme's suggestions. 😍

[GCdePaula]

Can you try to follow the instructions to run the node?

@claudioantonio @guidanoli @miltonjonat

[miltonjonat]

Great to have this!

[miltonjonat]

Can you try to follow the instructions to run the node?

@claudioantonio @guidanoli @miltonjonat

Didn't work for me:

 => [ 9/15] ADD ./permissionless-arbitration/contracts/src/ ./src/                                                                                                                                                  0.1s
 => [10/15] RUN forge --version                                                                                                                                                                                     0.3s
 => ERROR [11/15] RUN forge build                                                                                                                                                                                   0.5s
------
 > [11/15] RUN forge build:
0.498 Error: 
0.498 failed to resolve file: "/app/contracts/../../machine-emulator-sdk/solidity-step/ready_src/UArchStep.sol": No such file or directory (os error 2); check configured remappings.
0.498     --> "/app/contracts/src/tournament/abstracts/LeafTournament.sol"
0.498         "step/ready_src/UArchStep.sol"

[miltonjonat]

Ok, now it worked! I needed to download a bunch of submodules - and that's not on the README.

git submodule update --init --recursive

(I admit I don't like submodules very much, but that's a personal thing)

[guidanoli]

I had to run the command thrice, because some downloads would fail (but that's probably my internet's fault?).
Also, I had to run git submodule update --init --recursive.
This command should be on the Lua node README.

[GCdePaula]

Nice catches! I've updated with the requests. @claudioantonio can you take a look?

[claudioantonio]

It worked beautifully @GCdePaula ! ❤️
I only missed a brief description of what is the example, what I executed. 😉

[miltonjonat]

Yeah a quick description of what is executed would be cool, I was a bit lost too!

[guidanoli]

I agree. I had no idea what was being printed to me, as a newcomer.

[GCdePaula]

I've added more info to the readme!

I think we can improve the logging itself later in a different PR. It's good for debugging, but as a prototype showing newcomers what's going on, it may be improved.

Let me know if there's more improvements to the readme.

[miltonjonat]

LGTM

[augustoteixeira]

This is looking great!