Skip to content

docs: fix incorrect Linux PATH configuration for midenup #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
giwaov wants to merge 1 commit into
base: main
Choose a base branch
from
+135 −15
Open

docs: fix incorrect Linux PATH configuration for midenup #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 45 additions & 5 deletions docs/builder/quick-start/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,35 @@ Then add it to your shell configuration:
**For Zsh (macOS default):**

```bash title="~/.zshrc"
export PATH="/Users/$(whoami)/Library/Application Support/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/Library/Application Support/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.zshrc
```

**For Bash:**
**For Bash (Linux/Ubuntu):**

```bash title="~/.bashrc"
export PATH="$XDG_DATA_DIR/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/.local/share/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.bashrc
```

:::tip
On Linux, `midenup` uses XDG Base Directory paths. If `$XDG_DATA_HOME` is set, midenup installs to `$XDG_DATA_HOME/midenup`. Otherwise, it defaults to `~/.local/share/midenup`.
:::

**Install Miden Toolchain**

Install the latest stable Miden components:
Expand Down Expand Up @@ -156,10 +174,16 @@ which miden
<details>
<summary>Expected output</summary>

**macOS:**
```text
/Users/<USERNAME>/Library/Application Support/midenup/bin/miden
```

**Linux:**
```text
/home/<USERNAME>/.local/share/midenup/bin/miden
```

</details>

Test by creating a new project:
Expand All @@ -174,12 +198,28 @@ If successful, you'll see a new directory with Miden project files.

**"miden: command not found"**

This means the PATH isn't configured correctly. Verify midenup's bin directory is in your PATH:
This means the PATH isn't configured correctly. First, verify midenup installed successfully:

```bash title=">_ Terminal"
ls -la ~/.local/share/midenup/bin/ # Linux
ls -la ~/Library/Application\ Support/midenup/bin/ # macOS
```

You should see the `miden` executable. Then verify your PATH includes the midenup bin directory:

```bash title=">_ Terminal"
echo $PATH | grep midenup
```

If missing, re-add the export command to your shell configuration and reload it.
If missing, add the PATH configuration to your shell profile (see [Configure PATH](#configure-path) above) and reload it:

```bash title=">_ Terminal"
source ~/.bashrc # Linux
source ~/.zshrc # macOS
```

**Installation takes too long**

Building Miden components from source can take 30-60 minutes. This is normal for first-time installations.

---
50 changes: 45 additions & 5 deletions versioned_docs/version-0.11/quick-start/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,35 @@ Then add it to your shell configuration:
**For Zsh (macOS default):**

```bash title="~/.zshrc"
export PATH="/Users/$(whoami)/Library/Application Support/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/Library/Application Support/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.zshrc
```

**For Bash:**
**For Bash (Linux/Ubuntu):**

```bash title="~/.bashrc"
export PATH="$XDG_DATA_DIR/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/.local/share/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.bashrc
```

:::tip
On Linux, `midenup` uses XDG Base Directory paths. If `$XDG_DATA_HOME` is set, midenup installs to `$XDG_DATA_HOME/midenup`. Otherwise, it defaults to `~/.local/share/midenup`.
:::

**Install Miden Toolchain**

Install the latest stable Miden components:
Expand Down Expand Up @@ -170,10 +188,16 @@ which miden
<details>
<summary>Expected output</summary>

**macOS:**
```text
/Users/<USERNAME>/Library/Application Support/midenup/bin/miden
```

**Linux:**
```text
/home/<USERNAME>/.local/share/midenup/bin/miden
```

</details>

Test by creating a new project:
Expand All @@ -188,12 +212,28 @@ If successful, you'll see a new directory with Miden project files.

**"miden: command not found"**

This means the PATH isn't configured correctly. Verify midenup's bin directory is in your PATH:
This means the PATH isn't configured correctly. First, verify midenup installed successfully:

```bash title=">_ Terminal"
ls -la ~/.local/share/midenup/bin/ # Linux
ls -la ~/Library/Application\ Support/midenup/bin/ # macOS
```

You should see the `miden` executable. Then verify your PATH includes the midenup bin directory:

```bash title=">_ Terminal"
echo $PATH | grep midenup
```

If missing, re-add the export command to your shell configuration and reload it.
If missing, add the PATH configuration to your shell profile (see [Configure PATH](#configure-path) above) and reload it:

```bash title=">_ Terminal"
source ~/.bashrc # Linux
source ~/.zshrc # macOS
```

**Installation takes too long**

Building Miden components from source can take 30-60 minutes. This is normal for first-time installations.

---
50 changes: 45 additions & 5 deletions versioned_docs/version-0.12/quick-start/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,35 @@ Then add it to your shell configuration:
**For Zsh (macOS default):**

```bash title="~/.zshrc"
export PATH="/Users/$(whoami)/Library/Application Support/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/Library/Application Support/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.zshrc
```

**For Bash:**
**For Bash (Linux/Ubuntu):**

```bash title="~/.bashrc"
export PATH="$XDG_DATA_DIR/midenup/bin:$PATH"
export MIDENUP_HOME="$HOME/.local/share/midenup"
export PATH="$MIDENUP_HOME/bin:$PATH"
export PATH="$MIDENUP_HOME/opt:$PATH"
```

After editing, reload your shell:

```bash title=">_ Terminal"
source ~/.bashrc
```

:::tip
On Linux, `midenup` uses XDG Base Directory paths. If `$XDG_DATA_HOME` is set, midenup installs to `$XDG_DATA_HOME/midenup`. Otherwise, it defaults to `~/.local/share/midenup`.
:::

**Install Miden Toolchain**

Install the latest stable Miden components:
Expand Down Expand Up @@ -156,10 +174,16 @@ which miden
<details>
<summary>Expected output</summary>

**macOS:**
```text
/Users/<USERNAME>/Library/Application Support/midenup/bin/miden
```

**Linux:**
```text
/home/<USERNAME>/.local/share/midenup/bin/miden
```

</details>

Test by creating a new project:
Expand All @@ -174,12 +198,28 @@ If successful, you'll see a new directory with Miden project files.

**"miden: command not found"**

This means the PATH isn't configured correctly. Verify midenup's bin directory is in your PATH:
This means the PATH isn't configured correctly. First, verify midenup installed successfully:

```bash title=">_ Terminal"
ls -la ~/.local/share/midenup/bin/ # Linux
ls -la ~/Library/Application\ Support/midenup/bin/ # macOS
```

You should see the `miden` executable. Then verify your PATH includes the midenup bin directory:

```bash title=">_ Terminal"
echo $PATH | grep midenup
```

If missing, re-add the export command to your shell configuration and reload it.
If missing, add the PATH configuration to your shell profile (see [Configure PATH](#configure-path) above) and reload it:

```bash title=">_ Terminal"
source ~/.bashrc # Linux
source ~/.zshrc # macOS
```

**Installation takes too long**

Building Miden components from source can take 30-60 minutes. This is normal for first-time installations.

---