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

Jump to bottom

build instructions #210

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

build instructions #210

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
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ $ sudo xattr -rd com.apple.quarantine /Applications/GridPlayer.app
$ pip install -U gridplayer
```

**Python 3.8 or later required.**
**Python 3.8 or later required.** (_note: 3.12 and possibly a few previous versions do not work_)

This type of installation will also require a `vlc` package present in your system.
Copy link
Author

@whyboris whyboris Apr 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I don't understand what a "vlc package" means 😓
Do you mean install VLC into /Program Files ?

Please refer to [VLC official page](https://www.videolan.org/vlc/) for instructions on how to install it.

Some distros (e.g. Ubuntu) might also require `libxcb-xinerama0` package.

### From source
## Developing

This project uses [poetry](https://python-poetry.org/) for dependency management and packaging. You will have to install it first. See [poetry official documentation](https://python-poetry.org/docs/) for instructions.

Expand All @@ -113,6 +113,30 @@ $ poetry run gridplayer

The same notes about the Python version and external packages from **PIP** installation apply here.

## Building

Following example is for _Windows_, adjust the process for your OS.

```sh
bash scripts/_local/windows.sh
```

then

```sh
bash scripts/pyinstaller/build_win.sh
```

You will need to install [Inno Setup 6](https://jrsoftware.org/isdl.php)

finally

```sh
bash scripts/windows/build_packages.sh
```

If you have trouble, please open an [Issue](https://github.com/vzhd1701/gridplayer/issues)

## Video Decoder settings

GridPlayer supports two video output modes:
Expand Down