From 2b11413b7699323754c0bdbce0de4d32a625a310 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Tue, 2 Aug 2022 12:02:04 +0200 Subject: [PATCH] Website: reformat the "make targets" table No textual changes. --- .../content/development/building/_index.md | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/web/project-website/content/development/building/_index.md b/web/project-website/content/development/building/_index.md index 24cd2554..77f647ae 100644 --- a/web/project-website/content/development/building/_index.md +++ b/web/project-website/content/development/building/_index.md @@ -9,23 +9,23 @@ For the steps towards your first build, see [Getting Started][start]. These `make` targets are available: -| Target | Description | -| -- | -- | -| `application` | Builds Flamenco Manager, Worker, and the development version of the webapp. | -| `flamenco-manager` | Builds just Flamenco Manager. This includes packing the webapp and the Blender add-on into the executable. | -| `flamenco-worker` | Builds just Flamenco Worker. | +| Target | Description | +|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `application` | Builds Flamenco Manager, Worker, and the development version of the webapp. | +| `flamenco-manager` | Builds just Flamenco Manager. This includes packing the webapp and the Blender add-on into the executable. | +| `flamenco-worker` | Builds just Flamenco Worker. | | `flamenco-manager_race` | Builds Flamenco Manager with the [data race detector][race] enabled. As this is for development only, this does not include packing the webapp and the Blender add-on into the executable. | -| `flamenco-worker_race` | Builds Flamenco Worker with the [data race detector][race] enabled. | -| `webapp` | Installs the webapp dependencies, so that the development server can be run with `yarn --cwd web/app run dev --host` | -| `webapp-static` | Builds the webapp so that it can be served as static files by Flamenco Manager. | -| `addon-packer` | Builds the addon packer. This is a little Go tool that creates the Blender add-on ZIP file. Typically this target isn't used directly; the other Makefile targets depend on it. | -| `generate` | Generate the Go, Python, and JavaScript code. | -| `generate-go` | Generate the Go code, which includes OpenAPI code, as well as mocks for the unit tests. | -| `generate-py` | Generate the Python code, containing the OpenAPI client code for the Blender add-on. | -| `generate-js` | Generate the JavaScript code, containing the OpenAPI client code for the web interface. | -| `test` | Run the unit tests. | -| `clean` | Remove build-time files. | -| `version` | Print some version numbers, mostly for debugging the Makefile itself. | -| `list-embedded` | List the files embedded into the `flamenco-manager` executable. | +| `flamenco-worker_race` | Builds Flamenco Worker with the [data race detector][race] enabled. | +| `webapp` | Installs the webapp dependencies, so that the development server can be run with `yarn --cwd web/app run dev --host` | +| `webapp-static` | Builds the webapp so that it can be served as static files by Flamenco Manager. | +| `addon-packer` | Builds the addon packer. This is a little Go tool that creates the Blender add-on ZIP file. Typically this target isn't used directly; the other Makefile targets depend on it. | +| `generate` | Generate the Go, Python, and JavaScript code. | +| `generate-go` | Generate the Go code, which includes OpenAPI code, as well as mocks for the unit tests. | +| `generate-py` | Generate the Python code, containing the OpenAPI client code for the Blender add-on. | +| `generate-js` | Generate the JavaScript code, containing the OpenAPI client code for the web interface. | +| `test` | Run the unit tests. | +| `clean` | Remove build-time files. | +| `version` | Print some version numbers, mostly for debugging the Makefile itself. | +| `list-embedded` | List the files embedded into the `flamenco-manager` executable. | [race]: https://go.dev/doc/articles/race_detector