Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,43 @@ For technical documentation, visit [dev.poktroll.com](https://dev.poktroll.com).
Documentation is maintained in the [docusaurus repo](./docusaurus) and is
automatically deployed to the link above.

# Prerequisites

```bash
# Install required tools
brew install gnu-sed
brew install grep
brew install yq
brew install kind
brew install tilt
Comment on lines +40 to +44
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we single line this?


# Verify Go version (must be 1.23.x, NOT 1.24+)
go version
# Expected output: go1.23.12 darwin/arm64
Comment on lines +46 to +48
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to update go.mod or other tooling to avoid additional cognitive overhead on the reader?


```


Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix spacing here and below


# Quickstart (Localnet)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Quickstart (Localnet)
## Quickstart (Localnet)

```
# Start the local network
make localnet_up

# Initialize accounts (required for relays & tests)
make acc_initialize_pubkeys POCKET_NODE=http://localhost:26657
```
Troubleshooting
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing header


If you see this error:"Failed to receive any response from endpoints..."

It usually means you forgot to run the make acc_initialize_pubkeys step.
```



## License

This project is licensed under the MIT License; see the [LICENSE](https://github.com/pokt-network/poktroll/blob/main/LICENSE) file for details.
This project is licensed under the MIT License.
See the [LICENSE](https://github.com/pokt-network/poktroll/blob/main/LICENSE) file for details.