From 26f1652952c544304640e4eaf25d356a781ef216 Mon Sep 17 00:00:00 2001
From: Collin Jackson <collin@nexus.xyz>
Date: Wed, 23 Oct 2024 11:47:15 -0700
Subject: [PATCH] docs: Update installation instructions with prerequisites,
 links (#18)

---
 CONTRIBUTING.md        |  3 +--
 clients/cli/Cargo.toml |  2 +-
 clients/cli/README.md  | 43 ++++++++++++++++++++++++++++++++++++++----
 3 files changed, 41 insertions(+), 7 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 843bd44..f2d3986 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,9 +39,8 @@ If you believe that you have uncovered a bug, please describe it to the best of
 
 As a starting point, in a bug report we will pretty much always want:
 
-- the Nexus network version/revision you are using;
 - the platform you are on, ideally both the operating system (Windows, macOS, or Linux) and the machine architecture (_e.g.,_ if you're using an M-series Mac) if you know them;
-- console logs from the CLI or web application showing errors ands status messages;
+- console logs from the CLI or web application showing errors and status messages;
 - concrete and comprehensive steps to reproduce the bug.
 
 Code snippets should be as minimal as possible. It is always better if you can reproduce the bug with a small snippet that focuses on your Nexus zkVM usage rather than on the surrounding code in your project. This will help collaborators verify, reproduce, and zero in on a fix.
diff --git a/clients/cli/Cargo.toml b/clients/cli/Cargo.toml
index abd11a9..96c2295 100644
--- a/clients/cli/Cargo.toml
+++ b/clients/cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "nexus-network"
-version = "0.1.0"
+version = "0.3.1"
 edition = "2021"
 
 [[bin]]
diff --git a/clients/cli/README.md b/clients/cli/README.md
index be8b5b4..d0a94b1 100644
--- a/clients/cli/README.md
+++ b/clients/cli/README.md
@@ -1,6 +1,33 @@
-# network-cli
+# Network CLI
 
-Command line interface (CLI) for accessing the Nexus Network. Highest-performance option for proving.
+The command line interface (CLI) lets you run a Nexus prover node.
+It is the highest-performance option for proving.
+
+## Prerequisites
+
+If you don't have these dependencies already, install them first.
+
+### Linux
+
+```
+sudo apt update
+sudo apt upgrade
+sudo apt install build-essential pkg-config libssl-dev git-all
+```
+
+### macOS
+
+If you have [installed Homebrew](https://brew.sh/) to manage packages on OS X,
+run this command to install Git.
+
+```
+brew install git
+```
+
+### Windows
+
+[Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install),
+then see Linux instructions above.
 
 ## Quick start
 
@@ -12,12 +39,20 @@ If you do not already have Rust, you will be prompted to install it.
 
 ## Terms of Use
 
-Use of the CLI is subject to the [Terms of Use](https://nexus.xyz/terms_of_use).
+Use of the CLI is subject to the [Terms of Use](https://nexus.xyz/terms-of-use).
 The first time you run it, it prompts you to accept the terms. To accept the terms
 noninteractively (for example, in a continuous integration environment),
 add `NONINTERACTIVE=1` before `sh`.
 
 ## Known issues
 
-Currently only proving is supported. Submitting programs to the network is in private beta.
+* Only the latest version of the CLI is currently supported.
+* Prebuilt binaries are not yet available.
+* Counting cycles proved is not yet available in the CLI.
+* Only proving is supported. Submitting programs to the network is in private beta.
 To request an API key, contact us at growth@nexus.xyz.
+
+## Resources
+
+* [Network FAQ](https://nexus.xyz/network#network-faqs)
+* [Discord channel](https://discord.gg/nexus-xyz)