hiro/clay
1
0
Fork 0
mirror of https://github.com/vale981/clay synced 2025-03-05 17:41:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of github.com:and3rson/clay

Browse source
This commit is contained in:
Andrew Dunai 2018-02-06 19:09:55 +02:00
commit efc017d73a
1 changed files with 18 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -37,7 +37,8 @@ It's being actively developed, but is still in the early alpha version, so many
# Quick start # Quick start
```bash ```bash
sudo pip install clay-player sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo vlc keybinder python-keybinder
pip install --user clay-player
clay clay
``` ```
@ -51,6 +52,8 @@ Documentation is ![available here](http://clay.readthedocs.io/en/latest/).
- [gmusicapi] (PYPI) - [gmusicapi] (PYPI)
- [urwid] (PYPI) - [urwid] (PYPI)
- [PyYAML] (PYPI) - [PyYAML] (PYPI)
- [PyGObject] (native)
- [Keybinder] (native)
- lib[VLC] (native, distributed with VLC player) - lib[VLC] (native, distributed with VLC player)
# What works # What works
@ -80,14 +83,22 @@ Documentation is ![available here](http://clay.readthedocs.io/en/latest/).
# Installation # Installation
0. Install Python 3 and VLC. **Warning:** The AUR and PyPy packages called `python3-keybinder` will
not work with Clay since you need to use the official bindings. Since
Ubuntu seperated the official bindings into a different package but
with the same name as the unofficial one it can cause some
confusion. So if you get a `Namespace Keybinder not available` warning
it is probably caused by this. So, for example, on Arch Linux you need
the `libkeybinder3` package instead.
0. Install Python 3, PyGObject, keybinder and VLC from your package manager.
## Method 1 (PyPi, automatic) ## Method 1 (PyPi, automatic)
Just install the player using `pip`: Just install the player using `pip`:
```bash ```bash
pip install clay-player pip install --user clay-player
clay clay
``` ```
@ -95,10 +106,10 @@ clay
1. Clone the source code. 1. Clone the source code.
2. Create & activate virtualenv: 2. Create & activate virtualenv with system packages:
```bash ```bash
virtualenv .env virtualenv --system-site-packages --prompt="(clay) " .env
source .env/bin/activate source .env/bin/activate
``` ```
@ -209,4 +220,5 @@ Special thanks to the people who contribute to this project:
[VLC]: https://wiki.videolan.org/python_bindings [VLC]: https://wiki.videolan.org/python_bindings
[urwid]: urwid.org/ [urwid]: urwid.org/
[pyyaml]: https://github.com/yaml/pyyaml [pyyaml]: https://github.com/yaml/pyyaml
[PyGObject]: https://pygobject.readthedocs.io/en/latest/getting_started.html
[Keybinder]: https://github.com/kupferlauncher/keybinder