From 8a22dc889f9a83d06f9a1e4440184961f8a5c793 Mon Sep 17 00:00:00 2001
From: Howard Huang <howardhuang96@gmail.com>
Date: Mon, 16 Dec 2024 14:02:13 -0500
Subject: [PATCH] Update README with protobuf related installation (#42)

---
 README.md | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 28499c7..7dc3ea9 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Easy Per Step Fault Tolerance for PyTorch
 </h3>
 
 <p align="center">
-  | <a href="https://pytorch-labs.github.io/torchft/"><b>Documentation</b></a> 
+  | <a href="https://pytorch-labs.github.io/torchft/"><b>Documentation</b></a>
   | <a href="https://github.com/pytorch-labs/torchft/blob/main/media/fault_tolerance_poster.pdf"><b>Poster</b></a>
   | <a href="https://docs.google.com/document/d/1OZsOsz34gRDSxYXiKkj4WqcD9x0lP9TcsfBeu_SsOY4/edit"><b>Design Doc</b></a>
   |
@@ -45,13 +45,32 @@ greatly improve efficiency by avoiding stop the world training on errors.
 
 ![](./media/torchft-overview.png)
 
-## Installation
+## Prerequisites
+
+Before proceeding, ensure you have the following installed:
 
-Before proceeding, ensure you have Rust installed on your system. Note that the Rust versions available in many conda environments may be outdated. To install the latest version of Rust, we recommend downloading it directly from the official website as shown in the below command:
+- Rust (with necessaray dependencies)
+- `protobuf-compiler` and the corresponding development package for Protobuf.
+
+Note that the Rust versions available in many conda environments may be outdated. To install the latest version of Rust, we recommend downloading it directly from the official website as shown in the below command:
 ```sh
 $ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
 ```
 
+To install the required packages on a Debian-based system (such as Ubuntu) using apt, run:
+
+```sh
+sudo apt install protobuf-compiler libprotobuf-dev
+```
+
+or for a Red Hat-based system, run:
+
+```sh
+sudo dnf install protobuf-compiler protobuf-devel
+```
+
+## Installation
+
 ```sh
 $ pip install .
 ```