Skip to content
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

Use XDG base directory spec #93

Merged
merged 6 commits into from
Dec 4, 2024
Merged

Use XDG base directory spec #93

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
77088f3
Use XDG base directory spec
KaiWaldrant Jul 5, 2024
13459f3
update other installation path
KaiWaldrant Jul 5, 2024
f709581
Add comments
KaiWaldrant Jul 8, 2024
5d0a564
Merge remote-tracking branch 'origin/main' into 92-use-XDG
Grifs Jul 18, 2024
998309e
re-apply Kai's changes
Grifs Jul 18, 2024
eb067b5
Describe both system-wide and user-specific installations
tverbeiren Dec 3, 2024
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
40 changes: 34 additions & 6 deletions installation/index.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,14 @@ You can choose to install `default-jdk` instead of the more explicit `openjdk-17

## Linux

To install Viash to a `bin` folder in your current directory, run the following command to download and run the install script:
To install Viash to a `bin` folder on your PATH, run the following command to download and run the install script:

```bash
wget -qO- dl.viash.io | bash; mv viash $HOME/bin
wget -qO- dl.viash.io | bash
```

```bash
sudo mv viash /usr/local/bin
```

To verify your installation, run the following command:
Expand All @@ -154,12 +158,32 @@ viash --help

## macOS

To install Viash to a `bin` folder in your current directory, run the following command to download and run the install script:
Viash can be easily installed in the working directory by running the following command:

```bash
curl -fsSL dl.viash.io | bash; mv viash $HOME/bin
curl -fsSL dl.viash.io | bash
```

This will download the Viash binary to the current working directory and make it executable.

Next, the Viash executable can be moved to either a system location (`/usr/local/bin`) or a user location (`~/bin`):

1. To install the Viash executable to `/usr/local/bin`, simply run:

```bash
sudo mv viash /usr/local/bin
```

Please note that `sudo` rights are required.

2. To install Viash to the `$HOME/bin` folder, run the following command instead:

```bash
mv viash $HOME/bin/viash
```

Make sure to create the `~/bin` directory if it doesn't exist yet and add `~/bin` to the `$PATH` environment variable in your shell.

To verify your installation, run the following command:

```bash
Expand All @@ -168,10 +192,14 @@ viash --help

## Windows

To install Viash to a `bin` folder in your current directory, run the following command to download and run the install script:
To install Viash to a `bin` folder on your PATH, run the following command to download and run the install script:

```bash
wget -qO- dl.viash.io | bash
```

```bash
wget -qO- dl.viash.io | bash; mv viash $HOME/bin
sudo mv viash /usr/local/bin
```

To verify your installation, run the following command:
Expand Down
Loading