Update documentation.

This commit is contained in:
David Given
2022-06-12 22:15:28 +02:00
parent 246e580bb5
commit 601e220b18
2 changed files with 10 additions and 7 deletions

View File

@@ -24,7 +24,7 @@ called `build.lua`:
cprogram {
name = 'prog',
srcs = { "./*.c" },
srcs = { "./source1.c", "./source2.c" },
}
This defines a rule `prog` which, when built, compiles all the source files in
@@ -61,7 +61,8 @@ If we move the library into another directory, we can invoke it like this:
* Targets containing a `+` refer to a named target in another build file. So,
on encountering the library in `prog3` above, ackbuilder will look for
`path/to/library/build.lua`, load it, and then try to find a target in it
called `library`.
called `library`. If you want to refer to a named target in the root
build file do `~+targetname`.
**Warning**: files are interpreted from top to bottom; every time a target
referring to another build file is seen for the first time, that file is
@@ -320,7 +321,7 @@ Easiest to explain with an example:
cprogram {
name = 'another_test',
srcs = { './*.c' },
srcs = { './source.c' },
vars = {
cflags = { '-g', '-O3' }
}
@@ -336,7 +337,7 @@ stack. However, you can do this:
cprogram {
name = 'another_test',
srcs = { './*.c' },
srcs = { './source.c' },
vars = {
["+cflags"] = { '-O3' }
}

View File

@@ -187,12 +187,14 @@ install some support packages.
- For Linux (this is Ubuntu, but this should apply to Debian too):
`ninja-build`, `libusb-1.0-0-dev`, `libsqlite3-dev`, `zlib1g-dev`,
`libudev-dev`, `protobuf-compiler`, `libwxgtk3.0-gtk3-dev`.
`libudev-dev`, `protobuf-compiler`, `libwxgtk3.0-gtk3-dev`,
`libfmt-dev`.
- For OSX with Homebrew: `ninja`, `libusb`, `pkg-config`, `sqlite`,
`protobuf`, `truncate`, `wxwidgets`.
`protobuf`, `truncate`, `wxwidgets`, `fmt`.
- For Windows with MSYS2: `make`, `ninja`, `mingw-w64-i686-libusb`,
`mingw-w64-i686-protobuf`, `mingw-w64-i686-sqlite3`, `mingw-w64-i686-zlib`,
`mingw-w64-i686-gcc`, `vim`, `diffutils`, `mingw-w64-i686-wxWidgets`.
`mingw-w64-i686-gcc`, `vim`, `diffutils`, `mingw-w64-i686-wxWidgets`,
`mingw-w64-i686-fmt`, `mingw-w64-i686-pkg-config`.
These lists are not necessarily exhaustive --- please [get in
touch](https://github.com/davidgiven/fluxengine/issues/new) if I've missed