[Docs] Move docs to seporate file.
This commit is contained in:
parent
bd7dc6edd2
commit
3872429e84
18
DOCS.md
Normal file
18
DOCS.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# KittehPlayer
|
||||||
|
A YouTube-like video player based on Qt, QML and libmpv.
|
||||||
|
## Configuration
|
||||||
|
### Config Location
|
||||||
|
- On linux the config file will be located at `~/.config/KittehPlayer/KittehPlayer.conf`
|
||||||
|
### Supported Languages
|
||||||
|
- `english`
|
||||||
|
- `french`
|
||||||
|
- `spanish`
|
||||||
|
- `german`
|
||||||
|
- `italian`
|
||||||
|
- `russian`
|
||||||
|
- `norweigan`
|
||||||
|
- If your language isn't listed above then please either contact me (details at bottom of readme) or make a PR with the translations which are located in the file `src/qml/translations.js`.
|
||||||
|
### MPV Config
|
||||||
|
- Since KittehPlayer's default backend is based on libmpv, you can use the mpv.conf from `~/.config/mpv/mpv.conf`.
|
||||||
|
### SVP Support
|
||||||
|
- KittehPlayer works with SVP, you just need to follow the same guides as for MPV.
|
16
README.md
16
README.md
|
@ -41,18 +41,4 @@ sudo apt-get build-dep mpv libmpv* ffmpeg
|
||||||
- The finished player will then be installed and you can launch it using `KittehPlayer`
|
- The finished player will then be installed and you can launch it using `KittehPlayer`
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
### Config Location
|
- For docs on KittehPlayer please view DOCS.md or `man KittehPlayer`
|
||||||
- On linux the config file will be located at `~/.config/KittehPlayer/KittehPlayer.conf`
|
|
||||||
### Supported Languages
|
|
||||||
- `english`
|
|
||||||
- `french`
|
|
||||||
- `spanish`
|
|
||||||
- `german`
|
|
||||||
- `italian`
|
|
||||||
- `russian`
|
|
||||||
- `norweigan`
|
|
||||||
- If your language isn't listed above then please either contact me (details at bottom of readme) or make a PR with the translations which are located in the file `src/qml/translations.js`.
|
|
||||||
### MPV Config
|
|
||||||
- Since KittehPlayer's default backend is based on libmpv, you can use the mpv.conf from `~/.config/mpv/mpv.conf`.
|
|
||||||
### SmoothVideo Project Support
|
|
||||||
- KittehPlayer works with SVP, you just need to follow the same guides as for MPV.
|
|
|
@ -18,7 +18,7 @@ mkdir -p appdir/usr/lib
|
||||||
if [ "$ARCH" == "" ]; then
|
if [ "$ARCH" == "" ]; then
|
||||||
ARCH="x86_64"
|
ARCH="x86_64"
|
||||||
fi
|
fi
|
||||||
wget $(curl -s https://api.github.com/repos/AppImage/AppImageUpdate/releases | grep browser_download_url | grep x86_64.AppImage | grep appimageupdatetool | grep -v zsync | cut -d'"' -f4) -O appdir/usr/bin/appimageupdatetool
|
wget `curl -s https://api.github.com/repos/AppImage/AppImageUpdate/releases | grep browser_download_url | grep x86_64.AppImage | grep appimageupdatetool | grep -v zsync | cut -d'"' -f4` -O appdir/usr/bin/appimageupdatetool
|
||||||
chmod +x appdir/usr/bin/appimageupdatetool
|
chmod +x appdir/usr/bin/appimageupdatetool
|
||||||
|
|
||||||
wget https://yt-dl.org/downloads/latest/youtube-dl -O appdir/usr/bin/youtube-dl
|
wget https://yt-dl.org/downloads/latest/youtube-dl -O appdir/usr/bin/youtube-dl
|
||||||
|
|
Loading…
Reference in a new issue