docs: Add docs on installation (#1294)

This commit is contained in:
Joey Parrish 2023-10-19 10:54:52 -07:00 committed by GitHub
parent 562473c57e
commit ea311672f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions

View File

@ -125,6 +125,24 @@ build, `build/packager/Release/` for a Visual Studio release build, or
See [Shaka Packager Documentation](https://shaka-project.github.io/shaka-packager/html/) See [Shaka Packager Documentation](https://shaka-project.github.io/shaka-packager/html/)
on how to use `Shaka Packager`. on how to use `Shaka Packager`.
### Installation
To install Shaka Packager, run:
```shell
cmake --install build/ --strip --config Release
```
You can customize the output location with `--prefix` (default `/usr/local` on
Linux and macOS) and the `DESTDIR` environment variable. These are provided by
CMake and follow standard conventions for installation. For example, to build
a package by installing to `foo` instead of the system root, and to use `/usr`
instead of `/usr/local`, you could run:
```shell
DESTDIR=foo cmake --install build/ --strip --config Release --prefix=/usr
```
### Update your checkout ### Update your checkout
To update an existing checkout, you can run To update an existing checkout, you can run