Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ classDiagram

#### Packager

Packager is a tool for building Packages and Apps. It takes a Package Context as an input.
Packager is a tool for building Packages and Apps. It takes a Package Context as an input. It
supports both CMake and Meson build systems for building Packages.

Both `build-package` and `build-app` commands build Package or App specified in Package Context
in a Docker container based on existing Docker image built by `build-image` command, create a zip
Expand Down
8 changes: 4 additions & 4 deletions docs/example_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ The image defines a build environment for building Packages. Defined Docker imag
with some [requirements](https://github.com/bacpack-system/packager/blob/master/doc/DockerContainerRequirements.md),
briefly:

- CMake must be installed,
- CMake or Meson must be installed,
- SSH must be configured with root login and password `1234`,
- and `uname` must be installed.

Expand Down Expand Up @@ -160,9 +160,9 @@ use, the CMake options, etc. The Config structure is described in
Some of the important fields of Config are:

- `DependsOn` - list of dependency Packages, all Packages in the list must be defined in the same Package Context
- `Git/URI` - URI to a CMake based git repository with source code of the Package
- `Git/Revision` - tag or branch to use for build
- `Build/CMake/Defines` - CMake options
- `Git/URI` - URI to a CMake or Meson based git repository with source code of the Package
- `Git/Revision` - tag, branch or commit to use for build
- `Build/CMake/Defines` - CMake options (or `Build/Meson/Options` and `Build/Meson/Defines` for Meson)
- `Package/Name` - name of the Package
- `DockerMatrix/ImageNames` - list of Docker images to build the Package for

Expand Down