ash/litefin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update README

Browse source
This commit is contained in:
Ashhhleyyy 2024-01-24 21:55:08 +00:00
parent 342aa8541c
commit e7a88e8143
Signed by: ash
GPG key ID: 83B789081A0878FB
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -6,9 +6,9 @@ Lightweight media player using Jellyfin as a base.
Import your media library into Jellyfin, and ensure that the `Nfo` "Metadata saver" is enabled when importing; this makes Jellyfin write information about series into the source folder alongside the media files.
To generate the static HTML pages, use `cargo run -- --base-url <base url> --rewrite-root /media/ --output ./out <library directory>`
To generate the static HTML pages, use `cargo run -- --base-url <base url> --rewrite-root /media/ --output ./out <library directory> --player [vidstack|native]`.
`<base url>` should be replaced with the browser-accessible URL of the `<library directory>`. `--rewrite-root` is used to convert the image paths in the metadata files to the corresponding browser URL.
`<base url>` should be replaced with the browser-accessible URL of the `<library directory>`. `--rewrite-root` is used to convert the image paths in the metadata files to the corresponding browser URL. `--player` allows switching between a JavaScript based video player (vidstack) and the browser's native `<video>` element.
Once the command has completed, you can copy the contents of the output directory to your webserver, to allow the library to easily be browsed.