improve readme formatting

master
Carsten Haitzler 3 months ago
parent 73104c596f
commit e9de854fbc
  1. 47
      README.md

@ -12,23 +12,20 @@ This is a Video + Audio player along the lines of mplayer. It's simple
yet decent looking. It finds album art for you for music files,
generates thumbnails for videos so you can select logaction by
thumbnail and more. It accepts file lists on the cmdline ala:
```
rage file1.mp3 file2.mp3 file3.avi file4.mp4 file5.ogg
rage dvd:/
rage http://www.blah.com/stream
```sh
rage file1.mp3 file2.mp3 file3.avi file4.mp4 file5.ogg
rage dvd:/
rage http://www.blah.com/stream
```
You can also specify subtitle files with -sub:
```
rage file.mp4 -sub mysubs.srt
```sh
rage file.mp4 -sub mysubs.srt
```
And of course you can run it with no arguments:
```
rage
```sh
rage
```
Which goes into "Browser mode" where Rage will index/list your
@ -151,13 +148,13 @@ headers (e.g. libc6-dev) etc.
Depending on where dependencies (like efl) are installed, you might have to
set your `PKG_CONFIG_PATH` environment variable like:
```
```sh
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig
```
Also note that some distributions like to add extra arch directories
to your library locations so you might have to have more like:
```
```sh
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/local/lib64/pkgconfig:/usr/local/lib/x86_64-linux-gnu/pkgconfig:/usr/lib/pkgconfig:/usr/lib64/pkgconfig:/usr/lib/x86_64-linux-gnu/pkgconfig
```
@ -169,66 +166,66 @@ ld.so.conf for your distribution.
You might also want to add the destination bin dir to your environment
variable PATH (see documentation on your shell PATH variable) such as:
```
```sh
export PATH=/usr/local/bin:/usr/bin:/bin
```
Normal compilation in /usr/local:
```
```sh
meson . build
ninja -C build
sudo ninja -C build install
```
For meson build generic options:
```
```sh
meson --help
```
For a list of project specific options supported:
```
```sh
cat meson_options.txt
```
To set 1 or more project specific options:
```
```sh
meson --prefix=/path/to -Doption=value [-Dother=value2] [...] . build
```
To display current configuration:
```
```sh
meson configure build
```
The above will only work after at least the following is done:
```
```sh
meson . build
```
### Quick build help
How clean out the build and config and start fresh:
```
```sh
rm -rf build
```
How to make a dist tarball and check its build:
(must do it from git tree clone and commit all changes to git first)
```
```sh
ninja -C build dist
```
How to change prefix:
```
```sh
meson --prefix=/path/to/prefix . build
```
How to install in a specific destination directory for packaging:
```
```sh
DESTDIR=/path/to/destdir ninja -C build install
```
How to build with verbose output (full commands run):
```
```sh
ninja -C build -v
```

Loading…
Cancel
Save