Skip to content

Commit

Permalink
Merge pull request #109 from huwshimi/pip-instructions
Browse files Browse the repository at this point in the history
Improve instructions for installing dotrun
  • Loading branch information
huwshimi committed Nov 23, 2022
2 parents 422e8ab + 502d313 commit 53a97a2
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,31 @@ $ dotrun --env FOO=bar {script} # Run {script} with FOO environment variable

## Installation

### Docker

First, install Docker ([Get Docker](https://docs.docker.com/get-docker/)).

Linux users may also need to follow the [post install instructions](https://docs.docker.com/engine/install/linux-postinstall/) to be able to run Docker as a non-root user.

### Linux

To install dotrun run:

```
sudo apt install python3-pip
sudo pip3 install dotrun
```

### Mac

To install dotrun on a mac you will need [Homebrew](https://brew.sh/) (follow
the install
instructions on that page).

Then run:

```
brew install python3
sudo pip3 install dotrun
```

Expand All @@ -43,12 +66,12 @@ sudo pip3 install dotrun
### macOS performance

For optimal performance on Docker we recommend enabling a new experimental file sharing implementation called virtiofs. Virtiofs is only available to users of the following macOS versions:

- macOS 12.2 and above (for Apple Silicon)
- macOS 12.3 and above (for Intel)

[How to enable virtiofs](https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/)


## Add dotrun on new projects

To fully support dotrun in a new project you should do the following:
Expand Down

0 comments on commit 53a97a2

Please sign in to comment.