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

README: Add WSL install #171

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: Add WSL install #171

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: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ commands that you don't already trust on your system, (i.e. network calls are al
* `attr` (for `getfattr`)
* `pandoc` and `autoconf` (if working from a GitHub clone)

To install these packages, run the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is debian/Ubuntu specific. Best to leave it out?

```ShellSession
$ sudo apt install util-linux attr pandoc autoconf expect
```
In cases where overlayfs doesn't work on nested mounts, you will need either
[mergerfs](https://github.com/trapexit/mergerfs) or [unionfs](https://github.com/rpodgorny/unionfs-fuse). `try` should be able to autodetect them, but you can specify the path to mergerfs or unionfs with -U (e.g. `try -U ~/.local/bin/unionfs`)

Expand Down Expand Up @@ -89,6 +93,21 @@ cd try
makepkg -sic
```

#### WSL2
It is highly recommended to use [unionfs](https://github.com/rpodgorny/unionfs-fuse) to run `try`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will try even work without it? Then it's not "highly recommended", but required for use on WSL!

Especially when *overlayfs* doesn't work properly.

To install `unionfs` for your WSL, run the following:
```ShellSession
$ sudo apt install unionfs-fuse
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debian/Ubuntu specific.

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is unnecessary: we have plenty of description of how to run try.

Then you can go to the directory of `try` and simply run this as test:
```ShellSession
$ cd try
$ ./try ls
```
Also you can run test suite mentioned above.

## Example Usage

`try` is a higher-order command, like `xargs`, `exec`, `nohup`, or `find`. For example, to install a package via `pip3`, you can invoke `try` as follows:
Expand Down
Loading