Skip to content
This repository was archived by the owner on Aug 21, 2024. It is now read-only.

Commit 08eb76b

Browse files
committed
Improve Windows setup instructions.
1 parent 0300b96 commit 08eb76b

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

docs/getting-started/setup.mdx

+32-3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ This page has been migrated to the Stellar Developers documentation. Please [cli
3131
/>
3232
</head>
3333

34+
import Tabs from "@theme/Tabs";
35+
import TabItem from "@theme/TabItem";
36+
3437
Soroban contracts are small programs written in the [Rust] programming language.
3538

3639
To build and develop contracts you need only a couple prerequisites:
@@ -41,13 +44,29 @@ To build and develop contracts you need only a couple prerequisites:
4144

4245
## Install Rust
4346

47+
### Linux, macOS, or other Unix-like OS
48+
4449
If you use macOS, Linux, or another Unix-like OS, the simplest method to install a Rust toolchain is to install `rustup`. Install `rustup` with the following command.
4550

4651
```bash
4752
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
4853
```
4954

50-
If you use Windows, or need an alternative method of installing Rust, check out: https://www.rust-lang.org/tools/install
55+
### Windows
56+
57+
On Windows, download and run [rustup-init.exe](https://static.rust-lang.org/rustup/dist/i686-pc-windows-gnu/rustup-init.exe). You can continue with the default settings by pressing Enter.
58+
59+
:::info
60+
61+
**Protip:** The soroban CLI uses emojis. To properly render them on Windows, we recommend using [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/). See [how to install Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install) on Microsoft Learn.
62+
63+
:::
64+
65+
If you're already using [WSL](https://learn.microsoft.com/en-us/windows/wsl/install), you can also follow the instructions for Linux.
66+
67+
### Other
68+
69+
For other methods of installing [Rust], check out: https://www.rust-lang.org/tools/install
5170

5271
## Install the target
5372

@@ -130,7 +149,7 @@ TESTING_OPTIONS:
130149

131150
:::info
132151

133-
**Protip:** You can use `soroban completion` to generate shell completion for `bash`, `elvish`, `fish`, `powershell`, and `zsh`. You should absolutely try it out. It will feel like a super power!!
152+
**Protip:** You can use `soroban completion` to generate shell completion for `bash`, `elvish`, `fish`, `powershell`, and `zsh`. You should absolutely try it out. It will feel like a super power!
134153

135154
To enable autocomplete in the current bash shell, run:
136155

@@ -154,11 +173,21 @@ Soroban has a test network called Testnet that you can use to deploy and test yo
154173

155174
To configure your CLI to interact with Testnet, run the following command:
156175

176+
<Tabs>
177+
<TabItem value="nix" label="macOS/Linux">
157178
```bash
158-
soroban network add --global testnet \
179+
soroban network add \
180+
--global testnet \
159181
--rpc-url https://soroban-testnet.stellar.org:443 \
160182
--network-passphrase "Test SDF Network ; September 2015"
161183
```
184+
</TabItem>
185+
<TabItem value="windows" label="Windows">
186+
```bash
187+
soroban network add --global testnet --rpc-url https://soroban-testnet.stellar.org:443 --network-passphrase "Test SDF Network ; September 2015"
188+
```
189+
</TabItem>
190+
</Tabs>
162191

163192
Note the `--global` flag. This creates a file in your home folder's `~/.config/soroban/network/testnet.toml` with the settings you specified. This means that you can use the `--network testnet` flag in any Soroban CLI command to use this network from any directory or filepath on your system.
164193

0 commit comments

Comments
 (0)