improve readme formatting

This commit is contained in:
Carsten Haitzler 2022-06-04 15:22:42 +01:00
parent 73104c596f
commit e9de854fbc
1 changed files with 22 additions and 25 deletions

View File

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