From 91b7cb29f8294f171b1969ba08d6a3d678549e10 Mon Sep 17 00:00:00 2001
From: Josh Stein <46639943+jcstein@users.noreply.github.com>
Date: Mon, 16 Oct 2023 16:20:47 -0400
Subject: [PATCH] chore: update readme for use in rollkit docs in place of
"building-with-rollkit" page (#1247)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
## Overview
This PR edits the README.md in rollkit/rollkit to allow it to be adapted
directly into the documentation site.
This:
- [x] adds external links to any internal links within the repo, e.g.
`./contributing.md`
- [x] adds hard break after github badges so as to not cramp the top of
the page when it is in the docs. see images for context. no space is
as-is currently, the version with space is how it will look with hard
breaks
- [x] uses sentence-case for headings
Example without hard break:
Example with hard break:
## Checklist
- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
p.s. dang my fork is still rollmint, good times
---------
Co-authored-by: Manav Aggarwal
---
README.md | 92 +++++++++++++++++++++++++++++++++----------------------
1 file changed, 56 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
index f3a2310c6b5..6765abc5ead 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,15 @@
A modular framework for rollups, with an ABCI-compatible client interface. For more in-depth information about Rollkit, please visit our [website](https://rollkit.dev).
-[![build-and-test](https://github.com/rollkit/rollkit/actions/workflows/test.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/test.yml)
-[![golangci-lint](https://github.com/rollkit/rollkit/actions/workflows/lint.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/lint.yml)
-[![Go Report Card](https://goreportcard.com/badge/github.com/rollkit/rollkit)](https://goreportcard.com/report/github.com/rollkit/rollkit)
-[![codecov](https://codecov.io/gh/rollkit/rollkit/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/rollkit/rollkit)
+
+[![build-and-test](https://github.com/rollkit/rollkit/actions/workflows/test.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/test.yml)
+[![golangci-lint](https://github.com/rollkit/rollkit/actions/workflows/lint.yml/badge.svg)](https://github.com/rollkit/rollkit/actions/workflows/lint.yml)
+[![Go Report Card](https://goreportcard.com/badge/github.com/rollkit/rollkit)](https://goreportcard.com/report/github.com/rollkit/rollkit)
+[![codecov](https://codecov.io/gh/rollkit/rollkit/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/rollkit/rollkit)
[![GoDoc](https://godoc.org/github.com/rollkit/rollkit?status.svg)](https://godoc.org/github.com/rollkit/rollkit)
+
-## Building From Source
+## Building from source
Requires Go version >= 1.20.
@@ -16,18 +18,18 @@ To build:
```sh
git clone https://github.com/rollkit/rollkit.git
-cd rollkit
+cd rollkit
go build -v ./...
```
-## Building With Rollkit
+## Building with Rollkit
While Rollkit is a modular framework that aims to be compatible with a wide
range of data availability layers, settlement layers, and execution
environments, the most supported development environment is building on Celestia
as a data availability layer.
-### Building On Celestia
+### Building on Celestia
There are currently 2 ways to build on Celestia:
@@ -36,33 +38,43 @@ There are currently 2 ways to build on Celestia:
#### Compatibility
-| network | rollkit | celestia-node | celestia-app |
-|-----------------------|------------|---------------|--------------|
-| local-celestia-devnet | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
-| arabica-10 | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
-| mocha-4 | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
+| network | rollkit | celestia-node | celestia-app |
+| --------------------- | ------- | ------------- | ------------ |
+| local-celestia-devnet | v0.10.4 | v0.11.0-rc12 | v1.0.0-rc14 |
+| arabica | v0.10.4 | v0.11.0-rc13 | v1.0.0-rc14 |
-| rollkit/cosmos-sdk | cometbft | rollkit |
-|-----------------------------------------------------------|------------------------------------|------------|
-| [v0.47.3-rollkit-v0.10.4-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.47.3-rollkit-v0.10.4-no-fraud-proofs) | v0.37.2 | [v0.10.4](https://github.com/rollkit/rollkit/releases/tag/v0.10.4) |
-| [v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs) | v0.38.0-rc3 | [v0.11.0-rc1](https://github.com/rollkit/rollkit/releases/tag/v0.11.0-rc1)|
+
+| rollkit/cosmos-sdk | rollkit/cometbft | rollkit |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------------------------------------------------------------------------- |
+| [v0.47.3-rollkit-v0.10.4-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.47.3-rollkit-v0.10.4-no-fraud-proofs) | v0.37.2 | [v0.10.4](https://github.com/rollkit/rollkit/releases/tag/v0.10.4) |
+| [v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs](https://github.com/rollkit/cosmos-sdk/releases/tag/v0.50.0-rc.0-rollkit-v0.11.0-rc1-no-fraud-proofs) | v0.38.0-rc3 | [v0.11.0-rc1](https://github.com/rollkit/rollkit/releases/tag/v0.11.0-rc1) |
+
-#### Local Development Environment
+#### Local development environment
The Rollkit v0.10.4 release is compatible with the
-[local-celestia-devnet](https://github.com/rollkit/local-celestia-devnet)
-[v0.11.0-rc12](https://github.com/rollkit/local-celestia-devnet/releases/tag/v0.11.0-rc12) release. This version combination is compatible with
-[celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc14 and
-[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc12.
-
-#### Arabica and Mocha Testnets
-
-The Rollkit v0.10.4 release is compatible with [arabica-10](https://docs.celestia.org/nodes/arabica-devnet/) devnet [mocha-4](https://docs.celestia.org/nodes/mocha-testnet/) testnet which are running [celestia-app](https://github.com/celestiaorg/celestia-app) v1.0.0-rc14 and
-[celestia-node](https://github.com/celestiaorg/celestia-node) v0.11.0-rc12.
+[local-celestia-devnet](https://github.com/rollkit/local-celestia-devnet) [v0.11.0-rc12](https://github.com/rollkit/local-celestia-devnet/releases/tag/v0.11.0-rc12)
+release. This version combination is compatible with celestia-app
+[v1.0.0-rc14](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc14)
+and celestia-node
+[v0.11.0-rc12](https://github.com/celestiaorg/celestia-node/releases/tag/v0.11.0-rc8).
+
+#### Arabica devnet and Mocha testnet
+
+The Rollkit v0.10.4 release is compatible with
+[arabica-10](https://docs.celestia.org/nodes/arabica-devnet/) devnet
+[mocha-4](https://docs.celestia.org/nodes/mocha-testnet/) testnet which are running
+celestia-app
+[v1.0.0-rc14](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc14)
+and celestia-node
+[v0.11.0-rc12](https://github.com/celestiaorg/celestia-node/releases/tag/v0.11.0-rc8).
#### Cometbft v0.38.x and Cosmos-SDK v0.50.x
-The Rollkit v0.11.0-rc1 release is compatible with Cometbft v0.38.0-rc3 and Cosmos-SDK v0.50.0-rc.0. However, there is no support by ignite for launching a compatible app (e.g. gm app) and Rollkit is working on building a gm app for testing this release (WIP).
+The Rollkit v0.11.0-rc1 release is compatible with Cometbft v0.38.0-rc3 and Cosmos-SDK
+v0.50.0-rc.0. However, there is no support by ignite for launching a compatible app
+(e.g. gm app) and Rollkit is working on building a gm app for testing this
+release (WIP).
### Tools
@@ -71,7 +83,7 @@ The Rollkit v0.11.0-rc1 release is compatible with Cometbft v0.38.0-rc3 and Cosm
1. Install [hadolint](https://github.com/hadolint/hadolint)
1. Install [yamllint](https://yamllint.readthedocs.io/en/stable/quickstart.html)
-## Helpful Commands
+## Helpful commands
```sh
# Run unit tests
@@ -90,19 +102,27 @@ make proto-lint
## Contributing
-We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code,
-documentation, bug reports, feature requests, or anything else.
+We welcome your contributions! Everyone is welcome to contribute, whether it's
+in the form of code, documentation, bug reports, feature
+requests, or anything else.
-If you're looking for issues to work on, try looking at the [good first issue list](https://github.com/rollkit/rollkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!
+If you're looking for issues to work on, try looking at the
+[good first issue list](https://github.com/rollkit/rollkit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+Issues with this tag are suitable for a new external contributor and is a great
+way to find something you can help with!
-See [the contributing guide](./CONTRIBUTING.md) for more details.
+See
+[the contributing guide](https://github.com/rollkit/rollkit/blob/main/CONTRIBUTING.md)
+for more details.
-Please join our [Community Discord](https://discord.com/invite/YsnTPcSfWQ) to ask questions, discuss your ideas, and connect with other contributors.
+Please join our
+[Community Discord](https://discord.com/invite/YsnTPcSfWQ)
+to ask questions, discuss your ideas, and connect with other contributors.
-## Dependency Graph
+## Dependency graph
To see our progress and a possible future of Rollkit visit our [Dependency
-Graph](./specs/src/specs/rollkit-dependency-graph.md).
+Graph](https://github.com/rollkit/rollkit/blob/main/specs/src/specs/rollkit-dependency-graph.md).
## Code of Conduct