Skip to content

Commit fdfdd79

Browse files
committed
Update documentation.
1 parent c888c0e commit fdfdd79

1 file changed

Lines changed: 17 additions & 22 deletions

File tree

doc/building-client.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,26 @@ will work wherever ImHex does. Support platforms for the FluxEngine client inclu
99
well, although on Windows it'll need MSYS2 and mingw32. You'll need to
1010
install some support packages. **You will need to check out git with submodules enabled.**
1111

12-
- For Linux with Ubuntu/Debian:
13-
`libudev-dev` `libsqlite3-dev` `protobuf-compiler` `libfmt-dev`
14-
`libprotobuf-dev` `libmagic-dev` `libmbedtls-dev` `libcurl4-openssl-dev`
15-
`libmagic-dev` `libdbus-1-dev` `libglfw3-dev` `libfreetype-dev`
16-
`libboost-regex-dev` Plus, optionally (if not present, internal versions
17-
will be used): `nlohmann-json3-dev` `libcli11-dev` `libmd4c-dev`
18-
- For OSX with Homebrew:
19-
`sqlite` `pkg-config` `libusb` `protobuf` `fmt` `make` `coreutils`
20-
`dylibbundler` `libjpeg` `libmagic` `boost` `glfw3` `ninja` `python`
21-
`freetype2` `mbedtls` Plus, optionally (if not present, internal versions
22-
will be used): `nlohmann-json` `cli11` `md4c` `lunasvg`
23-
- For Windows with MSYS and pacboy:
24-
`python` `diffutils` `ninja` `make` `zip` `mingw-w64-cross-clang`
25-
`protobuf:p` `pkgconf:p` `curl-winssl:p` `file:p` `glfw:p` `mbedtls:p`
26-
`sqlite:p` `freetype:p` `boost:p` `gcc:p` `binutils:p` `nsis:p`
27-
`abseil-cpp:p`
28-
29-
There may be mistakes here --- please [get in
30-
touch](https://github.com/davidgiven/fluxengine/issues/new) if I've missed
31-
anything.
12+
- For Linux, see the dockerfiles in
13+
[tests/docker](https://github.com/davidgiven/fluxengine/tree/master/tests/docker).
14+
These are the source of truth for the dependencies and provide a known-good
15+
build script.
16+
- For OSX or Homebrew, see the Github CI scripts in
17+
[.github/workflows/release.yml](https://github.com/davidgiven/fluxengine/blob/master/.github/workflows/release.yml).
18+
These are a little harder to read (I haven't figured out how to do Windows or
19+
OSX docker yet).
3220

3321
Windows and Linux (and other Unixes) build by just doing `make`. OSX builds by
3422
doing `gmake` (we're using a feature which the elderly default make in OSX
35-
doesn't have). Parallel builds will be detected automatically; do `-j1` if for some
36-
reason you don't want one.
23+
doesn't have). Parallel builds will be detected automatically.
24+
25+
**Note for system packagers:** During the build, some remote dependencies will
26+
be pulled in automatically, so you'll need a network connection. If you don't
27+
want this to happen, you can vendor the appropriate dependencies by placing
28+
them in the `dep/r` directory. Look at the `gitrepository` lines in
29+
[build/dep/build.py](https://github.com/davidgiven/fluxengine/blob/ab/dep/build.py)
30+
to see what goes where.
31+
3732
You should end up with some executables in the current directory. The command line version
3833
is called `fluxengine` or `fluxengine.exe` depending on your platform,
3934
and the ImHex-based GUI will be `fluxengine-gui` or `fluxengine-gui.exe`.

0 commit comments

Comments
 (0)