docs: Update how to build the repository (#1243)

latticexyz · Aug 4, 2023 · f741ae8 · f741ae8
1 parent 6cc4911
commit f741ae8
Showing 1 changed file with 24 additions and 21 deletions.
diff --git a/docs/pages/contribute.mdx b/docs/pages/contribute.mdx
@@ -6,27 +6,30 @@ We'd love your support in improving MUD! This monorepo includes all of MUD's sou
 
 The following steps are only necessary if you want to contribute to MUD. To use MUD in your project, [set up a new project with the MUD cli](/quick-start).
 
-1. Install go (required to build [MODE](/mode)): [https://go.dev/doc/install](https://go.dev/doc/install)
-
-2. Install the foundry toolkit (required to build and test MUD solidity packages): [https://getfoundry.sh/](https://getfoundry.sh/)
-
-3. Install pnpm
-
-```bash
-npm install pnpm --global
-```
-
-4. Clone the MUD monorepo
-
-```
-git clone https://github.com/latticexyz/mud
-```
-
-5. Install MUD dependencies and setup local environment
-
-```
-cd mud && pnpm install
-```
+1. Ensure you have these applications installed:
+
+   | Software                                                                                    | Tested with version |
+   | ------------------------------------------------------------------------------------------- | ------------------- |
+   | [`curl`](https://curl.se/)                                                                  | 7.74.0              |
+   | [`node`](https://nodejs.org/en/download/package-manager)                                    | 18.17.0             |
+   | [`pnpm`](https://pnpm.io/)                                                                  | 8.6.11              |
+   | [`go` (at least version 1.20)](https://go.dev/dl/)                                          | 1.20.7              |
+   | [`make`](https://www.gnu.org/software/make/)                                                | 4.3                 |
+   | [`protoc`](https://grpc.io/docs/protoc-installation/#install-pre-compiled-binaries-any-os/) | 3.15.8              |
+
+1. Download the source code for MUD.
+
+   ```sh
+   git clone https://github.com/latticexyz/mud.git
+   cd mud
+   ```
+
+1. Install and build packages.
+
+   ```sh
+   pnpm install
+   pnpm build
+   ```
 
 ### Pull requests