From 28ac029c294e0a3d145d71c1e5b5500c6260a551 Mon Sep 17 00:00:00 2001 From: Favour Chidera Okoli Date: Sun, 22 Sep 2024 14:10:35 +0100 Subject: [PATCH] Updated README with 'table of content' and troubleshooting guidelines --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index f7e630ffe4..afce85eb54 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,15 @@ _The project is still heavily under construction, see the [disclaimer below](#st +## Table of Contents + +1. [What is BeaconKit?](#what-is-beaconkit) +2. [Supported Execution Clients](#supported-execution-clients) +3. [Running a Local Development Network](#running-a-local-development-network) +4. [Multinode Local Devnet](#multinode-local-devnet) +5. [Troubleshooting](#troubleshooting) +6. [Status](#status) + ## What is BeaconKit? [BeaconKit](https://docs.berachain.com/learn/what-is-beaconkit) is a modular framework for building EVM based consensus clients. @@ -72,6 +81,14 @@ preloaded with the native EVM token. Please refer to the [Kurtosis README](https://github.com/berachain/beacon-kit/blob/main/kurtosis/README.md) for more information on how to run a multinode local devnet. +## Troubleshooting + +If you encounter issues when running the commands, here are some common fixes: + +1. **Docker not starting**: Ensure Docker is running, and you have enough allocated resources (RAM, CPU). +2. **Golang version errors**: Check that you have Go 1.23.0 or above installed by running `go version`. +3. **Port conflicts**: If you receive a port conflict error, try stopping other services running on the same port or change the port configuration in the `docker-compose.yml` file. + ## Status This project is work in progress and subject to frequent changes as we are still working on wiring up the final system. Audits on BeaconKit are still ongoing, and in progress at the moment. We don't recommend using BeaconKit in a production environment yet.