Skip to content

Commit

Permalink
update arch build instructions
Browse files Browse the repository at this point in the history
also tweak wording around ASSETS build option

thanks to @CastixGitHub for this update
  • Loading branch information
benswift committed May 3, 2020
1 parent 909d87e commit a7b1f05
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
22 changes: 13 additions & 9 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ For platform-specific deps, see "Platform-specific notes" below.

See the top of `CMakeLists.txt` for all the available build options.

The most relevant option for new Extempore users is the `ASSETS` option. It's
off by default, but if set to `ON` the Extempore build process will download the
assets e.g. sound files, 3D model files which are referenced in the examples
(these asset files live in a [separate
repo](https://github.com/extemporelang/extempore-assets)).

It's off by default because it's pretty big (~300MB) download, so make sure
you're on an internet connection where you don't mind downloading a bunch of
data. If you don't set `-DASSETS=ON` at build time that's ok---CMake will still
create an `assets` target which you can "build" afterwards to downoad the assets
and move them into place.

## Targets

The default target will build Extempore, all the dependencies, and AOT-compile
Expand All @@ -31,11 +43,6 @@ following targets might come in handy:

- the `clean_aot` target will remove all AOT-compiled files

- the `assets` target won't build anything per. se., but it will download the
assets e.g. sound files, 3D model files which are referenced in the examples
(it's pretty big, so make sure you're on an internet connection where you
don't mind downloading a bunch of data)

## Platform-specific notes

### macOS
Expand Down Expand Up @@ -80,10 +87,7 @@ On Ubuntu 18.04-20.04 you can get the required deps with:

#### Arch

There's an [AUR package](https://aur.archlinux.org/packages/extempore-git/) but
it's currently out-of-date; [@Lapin0t](https://github.com/Lapin0t/extempore-aur)
has updated the [build script](https://github.com/Lapin0t/extempore-aur) (March
2020) which _might_ help, ymmv.
There's an [AUR package](https://aur.archlinux.org/packages/extempore-git/)

### Windows

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ you go.

### Build from source

**For more information**, check out [BUILDING.md](./BUILDING.md).

Extempore's CMake build process downloads and build all the dependencies you
need (including LLVM). So, if you've got a C++ compiler, git and CMake, here are
some one-liner build commands:
Expand All @@ -45,8 +47,6 @@ for many of the examples, but adds a ~300MB download to build process. If you'd
rather not do that, and are happy with some of the examples not working, then
set `-DASSETS=OFF` instead.

For more information, check out `BUILDING.md`.

## See Extempore in action

Check out these videos:
Expand Down

0 comments on commit a7b1f05

Please sign in to comment.