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

Update README #305

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

Update README #305

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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,14 @@ PiShrink can be ran on Windows using [Windows Subsystem for Linux](https://learn
```
4. Build the container by running:
```bash
docker build -t pishrink .
docker buildx --platform=linux/amd64 -t pishrink .
```
6. Create an alias to run PiShrink:
6. Create an alias to run PiShrink, note this alias has a `-` in it to avoid a circular reference.
```bash
echo "alias pishrink='docker run -it --rm --platform linux/amd64 --privileged=true -v $(pwd):/workdir pishrink'" >> ~/.bashrc && source ~/.bashrc
echo "alias pi-shrink='docker run -it --rm --platform linux/amd64 --privileged=true -v $(pwd):/workdir pishrink'" >> ~/.bashrc && source ~/.bashrc
```

You can now run the `pishrink` command as normal to shrink your images.
You can now run the `pi-shrink` command as normal to shrink your images.

> [!WARNING]
> You MUST change directory into the images folder for this command to work. The command mounts your current working directory into the container so absolute file paths will not work. Relative paths should work just fine as long as they are below your current directory.
Expand Down Expand Up @@ -123,3 +123,4 @@ Shrunk pi.img from 30G to 3.1G
If you find a bug please create an issue for it. If you would like a new feature added, you can create an issue for it but I can't promise that I will get to it.

Pull requests for new features and bug fixes are more than welcome!