From 19d4a79758714772ef32dbbe6530badc5d37880f Mon Sep 17 00:00:00 2001 From: Bryan White Date: Fri, 13 Dec 2024 00:14:50 +0100 Subject: [PATCH] docs: update README --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b74d3ae..e5f65ab 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,29 @@ This repo contains an asynchronous C API to the [Poktroll client packages](https://pkg.go.dev/github.com/pokt-network/poktroll/pkg/client) via [cgo](https://pkg.go.dev/cmd/cgo) wrapper functions. -## Getting started +## Table of contents + +- [Quickstart](#quickstart) +- [Getting started (development environment)](#getting-started-development-environment) +- [Linux](#linux) + - [Building shared libraries](#building-shared-libraries-1) + - [Building installers](#building-installers-1) +- [MacOS](#macos) +- [Cross-compiling from (arch) linux](#cross-compiling-from-arch-linux-1) + - [Targeting Windows](#targeting-windows) + - [Targeting macOS](#targeting-macos) + + +## Quickstart + +You can _EITHER_ **download** or **build** an OS/architecture-specific installer or shared library. +Downloads are available via the [releases page](https://github.com/bryanchriswhite/libpoktroll-clients/releases). +To build from source, see the relevant sections below (and/or the ToC above). + +## Getting started (development environment) ```bash # Clone and cd into the repo. -git clone https://github.com/bryanchriswhite/libpoktroll_clients.git --recurse-submodules +git clone https://github.com/bryanchriswhite/libpoktroll-clients.git --recurse-submodules cd libpoktroll_clients # If you cloned but didn't pull the submodules, run: