Skip to content

Commit

Permalink
Add build & l10n instructions
Browse files Browse the repository at this point in the history
Meson is a great build system. Adding some basic instructions to the
README should help new users to install Gydl properly.

Without the build system translations will not work.
  • Loading branch information
AsavarTzeth committed Sep 13, 2017
1 parent bded023 commit 0e934f4
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,66 @@ Thanks for your patience.

Gydl is written in Python3 and uses the GTK+3 toolkit.

### Dependencies

To run it you need to have installed:

* gtk+3
* python3
* pygobject
* youtube-dl

### Build & Install

Meson installs to `/usr/local` as the default prefix.

```
meson build
cd build
ninja install
```

### Build Options

Use `meson --help` to get all build options. You may specify any option when
you initially run meson.

```
# Example
meson build --prefix=/app
```

If you already have a build directory, you must use instead use
`meson configure`, from within the build directory.

```
# Example
cd build
meson configure -Dprefix=/app
```

Meson also supports the **DESTDIR** environment variable, which is useful for
building a package.

[See Meson documentation for more](http://mesonbuild.com)


# Translation

Gydl itself is currently not translatable, but the appdata and
the desktop entry is.

Use the build system to generate a POT template file from the latest commit.

```
meson build
ninja -C build Gydl-pot
rm -rf build
```

Copy the POT file into a PO file matching your language code and translate
all strings. Alternatively follow the above steps and use a tool like Poedit.

# Usage

When using Gydl, you have the option to download your Youtube Video as a
Expand Down

0 comments on commit 0e934f4

Please sign in to comment.