IntersectMBO / plutus-apps

The Plutus application platform
Apache License 2.0
305 stars 213 forks source link

PLT-1459: Updated README of marconi-chain-index and marconi-sidechain #988

Closed koslambrou closed 1 year ago

koslambrou commented 1 year ago

Note: The diff in the marconi-chain-index/README.md can be glanced over very quickly, as it's basically the same as the marconi-sidechain/README.md (minus the JSON-RPC server)

Pre-submit checklist:

eyeinsky commented 1 year ago

I found the readme that is now renamed to draft useful when I first joined as it gave an overview of what marconi did. While the new parts on how to build and run is also useful, then maybe they could be merged instead -- as the new readme is brief on what marconi does, what it's architecture is, etc.

koslambrou commented 1 year ago

I found the readme that is now renamed to draft useful when I first joined as it gave an overview of what marconi did. While the new parts on how to build and run is also useful, then maybe they could be merged instead -- as the new readme is brief on what marconi does, what it's architecture is, etc.

@eyeinsky I agree that it's very valuable. However, it is not the README for marconi-chain-index, but README for the Marconi project as a whole. That draft README would essentially be the README for the marconi project once we split it in a separate repo.