Merge pull request #242 from EmmanuelAR/feat/241

[fix] update backend README
web3wagers · Nov 13, 2024 · 5445ca1 · 5445ca1
2 parents a86e2d8 + bf11551
commit 5445ca1
Showing 1 changed file with 39 additions and 39 deletions.
diff --git a/contracts/README.md b/contracts/README.md
@@ -12,22 +12,22 @@
 
 2. **Setup your environment**
 
-  - Scarb v2.6.5 : [here](https://docs.swmansion.com/scarb/download.html#install-via-asdf).
-    ```bash
-    asdf install scarb 2.6.5
-    ```
-    ```bash
-    asdf global scarb 2.6.5
-    ```
-  - Starknet Foundry v0.27.0: [here](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
-    ```bash
-     asdf install starknet-foundry 0.27.0   
-    ```
-    ```bash
-     asdf global starknet-foundry 0.27.0   
-    ```
-     **Setup your environment (Different option for macOS)**
-
+  - Option #1: Install Scarb and Starknet Foundry using asdf (Only macOS)
+    - Scarb v2.6.5 : [here](https://docs.swmansion.com/scarb/download.html#install-via-asdf).
+      ```bash
+      asdf install scarb 2.6.5
+      ```
+      ```bash
+      asdf global scarb 2.6.5
+      ```
+    - Starknet Foundry v0.27.0: [here](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
+      ```bash
+      asdf install starknet-foundry 0.27.0   
+      ```
+      ```bash
+      asdf global starknet-foundry 0.27.0   
+      ```
+  - Option #2: Install Scarb and Starknet Foundry using curl (Only macOS)
     - Scarb v2.6.5 : [here](https://docs.swmansion.com/scarb/download.html#install-via-asdf).
       ```bash
       curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh -s -- -v 2.6.5
@@ -38,7 +38,7 @@
       ```
       It is recommended to restart the terminal.
 
-    **Setup your environment (Ubuntu)**
+  - Option #3: Install Scarb and Starknet Foundry (Only Ubuntu)
      - Scarb v2.6.5 
         ```bash
         curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh -s -- -v 2.6.5
@@ -53,28 +53,28 @@
         ```
         It is recommended to restart the terminal.
 
-  - Starknet Foundry v0.27.0: [here](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
-      ```bash
-      curl -L https://raw.githubusercontent.com/foundry-rs/starknet-foundry/master/scripts/install.sh | sh -s -- -v 0.27.0
-      ```
-      **Place it in the path (Option for macOS):**
-      ```bash
-      echo 'export PATH="$HOME/.asdf/shims:$HOME/.asdf/bin:$PATH"' >> ~/.zshrc
-      ```
-      ```bash
-      echo 'export PATH="$HOME/.foundry/bin:$PATH"' >> ~/.zshrc
-      ```
-      **Place it in the path (Option for Ubuntu):**
-      ```bash
-      In the terminal: code ~ /.bashrc
-      ```
-      Place it at the end of the path/code:
-      ```bash
-      export PATH="$HOME/.asdf/shims:$HOME/.asdf/bin:$PATH"
-      ```
-      ```bash
-      export PATH="$HOME/.foundry/bin:$PATH"
-      ```
+    - Starknet Foundry v0.27.0: [here](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
+        ```bash
+        curl -L https://raw.githubusercontent.com/foundry-rs/starknet-foundry/master/scripts/install.sh | sh -s -- -v 0.27.0
+        ```
+        **Place it in the path (Option for macOS):**
+        ```bash
+        echo 'export PATH="$HOME/.asdf/shims:$HOME/.asdf/bin:$PATH"' >> ~/.zshrc
+        ```
+        ```bash
+        echo 'export PATH="$HOME/.foundry/bin:$PATH"' >> ~/.zshrc
+        ```
+        **Place it in the path (Option for Ubuntu):**
+        ```bash
+        In the terminal: code ~ /.bashrc
+        ```
+        Place it at the end of the path/code:
+        ```bash
+        export PATH="$HOME/.asdf/shims:$HOME/.asdf/bin:$PATH"
+        ```
+        ```bash
+        export PATH="$HOME/.foundry/bin:$PATH"
+        ```
 
 3. **Compile Go Stark Me Backend 🛠️**