Skip to content

Update installation docs #134

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

Closed
ofek wants to merge 1 commit into from
Closed

Update installation docs #134

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
19 changes: 17 additions & 2 deletions website/docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,12 @@ jobs:
- run: ./some_dotslash_file
```

## cargo install
## Package managers

DotSlash is available through several language- and platform-specific package
managers.

### Cargo

If you are familiar with the Rust toolchain, you can also build and install
DotSlash using `cargo`:
Expand All @@ -125,7 +130,7 @@ update any environment variables to get DotSlash to work.
Though note that `cargo install` does not create a universal binary, so you may
be better off [building from source](#build-from-source).

## Install from npm
### npm

To use DotSlash in Node.js projects, you can install it as a dependency:

Expand Down Expand Up @@ -153,6 +158,16 @@ const {spawnSync} = require('child_process');
spawnSync(dotslash, ['./some_dotslash_file'], {stdio: 'inherit']);
```

### Scoop

On Windows, DotSlash can be installed via [Scoop](https://scoop.sh):

```shell
scoop install dotslash
```

Scoop will place `dotslash.exe` on your `PATH` automatically.

## Build from source

The short version of the build process is:
Expand Down
Loading