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.

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

Add installation instructions #2085

Merged
merged 4 commits into from
Apr 3, 2024
Merged

Add installation instructions #2085

merged 4 commits into from
Apr 3, 2024

Conversation

vrabaud
Copy link
Collaborator

@vrabaud vrabaud commented Apr 2, 2024

This should fix #2081

Copy link
Collaborator

@y-guyon y-guyon left a comment

Choose a reason for hiding this comment

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

Thanks. Maybe Windows pre-built binaries section could be moved next to windows intall section?

@vrabaud
Copy link
Collaborator Author

vrabaud commented Apr 2, 2024

The "Prebuilt Library" section still refers to the appveyor binaries that are at HEAD. I consider it to be dev so let's leave it there for now. I added a mention to the official release page though.

README.md Outdated
You can also download the official windows binaries on the
[release](https://github.com/AOMediaCodec/libavif/releases) page.

### OSX
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: change "OSX" to "macOS" (the current name of the OS).

README.md Outdated
```sh
sudo apt install libavif-dev
```
RedHat-based distributions:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: "Red Hat" is spelled as two words.

@kmilos
Copy link
Contributor

kmilos commented Apr 3, 2024

Does it also make sense to mention libavif packages are also available in MSYS2 (Windows) and MacPorts?

@vrabaud
Copy link
Collaborator Author

vrabaud commented Apr 3, 2024

@kmilos sure, what are the instructions to install on those platforms? Thx

@kmilos
Copy link
Contributor

kmilos commented Apr 3, 2024

pacman -S mingw-w64-ucrt-x86_64-libavif (for the "default" MSYS2 UCRT64 environment; need to adapt the package triplet obviously for other target environments)

sudo port install libavif I guess for MacPorts...

@vrabaud vrabaud merged commit 3e0b4e0 into AOMediaCodec:main Apr 3, 2024
25 checks passed
@vrabaud vrabaud deleted the homebrew branch April 3, 2024 09:40
@kmilos
Copy link
Contributor

kmilos commented Apr 3, 2024

Btw, you could also add a "packaging status" like libheif and libjxl do 😉

@vrabaud
Copy link
Collaborator Author

vrabaud commented Apr 3, 2024

@kmilos
Copy link
Contributor

kmilos commented Apr 3, 2024

Copy link
Collaborator

@wantehchang wantehchang left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you (and Miloš) for adding the package installation instructions!

@@ -48,6 +53,13 @@ Red Hat-based distributions:
sudo yum -y install libavif
```

### MinGW
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: MinGW should be moved to the "Windows" section, at least next to it.

@wantehchang
Copy link
Collaborator

Vincent: I think it's good to add the libavif packaging status. I agree that table may grow too big, and it is more useful to us (libavif maintainers) than the end users. We can address that by setting up the link so that it opens a new page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Homebrew install instructions and avifdec/avifenc examples to README
4 participants