Skip to content

Commit

Permalink
Update build instructions in README
Browse files Browse the repository at this point in the history
CMake is not tested on macOS now, so don't include it in README. Be more specific on where to find dependencies.
  • Loading branch information
wangqr committed Mar 8, 2020
1 parent 3556c96 commit b557dfc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ script:
export PATH="/usr/local/opt/gettext/bin:/usr/local/opt/icu4c/sbin:/usr/local/opt/icu4c/bin:$PATH";
export CPPFLAGS="-I/usr/local/opt/gettext/include -I/usr/local/opt/icu4c/include";
export LDFLAGS="-L/usr/local/opt/gettext/lib -L/usr/local/opt/icu4c/lib";
export ACLOCAL_PATH="/usr/local/opt/gettext/share/aclocal"
export ACLOCAL_PATH="/usr/local/opt/gettext/share/aclocal";
export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig";
./autogen.sh;
./configure --enable-debug || cat config.log;
Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Support is available on IRC ( irc://irc.rizon.net/aegisub ).

## Building Aegisub

### autoconf / make (for \*nix)
### autoconf / make (for linux and macOS)

This is the recommended way of building Aegisub on \*nix systems. Currently AviSynth+ support is not included in autoconf project. If you need AviSynth+ support, see CMake instructions below.
This is the recommended way of building Aegisub on linux and macOS. Currently AviSynth+ support is not included in autoconf project. If you need AviSynth+ support, see CMake instructions below.

Aegisub has some required dependencies:
* `libass`
Expand All @@ -33,7 +33,11 @@ and optional dependencies:
* `uchardet`
* `AviSynth+`

You can use the package manager provided by your distro to install these dependencies. Package name varies by distro. For ArchLinux, refer to [AUR](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=aegisub-git). For Ubuntu, refer to [Travis](https://github.com/wangqr/Aegisub/blob/dev/.travis.yml).
You can use the package manager provided by your distro to install these dependencies. Package name varies by distro. Some useful references are:

* For ArchLinux, refer to [AUR](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=aegisub-git).
* For Ubuntu, refer to [Travis](https://github.com/wangqr/Aegisub/blob/dev/.travis.yml#L14-L35).
* For macOS, refer to [Travis](https://github.com/wangqr/Aegisub/blob/dev/.travis/install.sh#L6). In addition to the packages listed in the `brew install` line, you also need `automake` and `pkg-config`. They are not listed there because Travis preinstalled them. For some packages, you need to either [set environment variables during build](https://github.com/wangqr/Aegisub/blob/dev/.travis.yml#L54-L58) or [force link them](https://github.com/Aegisub/Aegisub/#os-x).

After installing the dependencies, you can clone and build Aegisub with:
```sh
Expand All @@ -44,7 +48,7 @@ cd Aegisub
make
```

### CMake (for all systems including Windows)
### CMake (for Windows and linux)

This fork also provides CMake build. The CMake project will only build Aegisub itself, without the translation.

Expand Down

0 comments on commit b557dfc

Please sign in to comment.