Skip to content

Commit

Permalink
Update README with macOS support
Browse files Browse the repository at this point in the history
Also add a minor note for the uninstall procedure.
  • Loading branch information
sgleizes committed Sep 24, 2021
1 parent bbd98c5 commit c00b03f
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,22 @@ See [usage](#usage) for examples and information about xsh commands.
## Dependencies

- GNU `coreutils`
- GNU `sed`
- `util-linux` (for `column`)
- `sed`
- A POSIX-compatible shell that is [supported](#supported-shells).

I haven't tried to run xsh on macOS or any other platform using the BSD
implementations of `coreutils` and `sed`, so this is uncharted territory.
If anyone is willing to try that, I'll be grateful for any provided feedback.
What is expected is that benchmarking will not work with the BSD implementation
of `date` (except for `zsh` which uses a more efficient method).
On most Linux systems, these programs should already be installed.

On macOS at least it is possible to install the GNU versions of `coreutils` and
`sed`, so that could be a workaround for users on this platform, although
compatibility with both implementations would be preferred. Please open
an issue if you find that it is not the case.
For Unix systems using the BSD implementations of `coreutils`, so far only macOS
is supported and requires the installation of GNU `coreutils` and `util-linux`:

```sh
brew install coreutils util-linux
```

The `coreutils` prefixed with `g` will automatically be used if available,
however the `column` utility from `util-linux` must be reachable from your
`PATH` for the `list` command to work.

## Supported shells

Expand Down Expand Up @@ -340,6 +343,9 @@ mv "${ZDOTDIR:-$HOME}/.zshrc.~1~" "${ZDOTDIR:-$HOME}/.zshrc"
mv "${ZDOTDIR:-$HOME}/.zlogout.~1~" "${ZDOTDIR:-$HOME}/.zlogout"
```

If the backup doesn't exist for any file above, you can safely delete the link
created by xsh for that file.

## Usage

Assuming `xsh bootstrap` was run (see [Installation](#Installation)), the
Expand Down

0 comments on commit c00b03f

Please sign in to comment.