blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Website: add new 'make' targets to the documentation

Browse Source
This commit is contained in:
Sybren A. Stüvel 2022-08-02 12:05:27 +02:00
parent b06992a997
commit beb302c2b4
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
web/project-website/content/development/building/_index.md
View File

@ -9,23 +9,26 @@ For the steps towards your first build, see [Getting Started][start].
These `make` targets are available: These `make` targets are available:
| Target | Description | | Target | Description |
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `application` | Builds Flamenco Manager, Worker, and the development version of the webapp. | | `application` | Builds Flamenco Manager, Worker, and the development version of the webapp. This is the default target when just running `make` |
| `flamenco-manager` | Builds just Flamenco Manager. This includes packing the webapp and the Blender add-on into the executable. | | `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-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-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. | | `flamenco-manager-without-webapp` | Builds Flamenco Manager without rebuilding the webapp. This is useful to speed up the build when you're using the webapp development server (see below) |
| `webapp` | Installs the webapp dependencies, so that the development server can be run with `yarn --cwd web/app run dev --host` | | `flamenco-worker_race` | Builds Flamenco Worker with the [data race detector][race] enabled. |
| `webapp-static` | Builds the webapp so that it can be served as static files by Flamenco Manager. | | `webapp` | Installs the webapp dependencies, so that the development server can be run with `yarn --cwd web/app run dev --host` |
| `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. | | `webapp-static` | Builds the webapp so that it can be served as static files by Flamenco Manager. |
| `generate` | Generate the Go, Python, and JavaScript code. | | `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-go` | Generate the Go code, which includes OpenAPI code, as well as mocks for the unit tests. | | `generate` | Generate the Go, Python, and JavaScript code. |
| `generate-py` | Generate the Python code, containing the OpenAPI client code for the Blender add-on. | | `generate-go` | Generate the Go code, which includes OpenAPI code, as well as mocks for the unit tests. |
| `generate-js` | Generate the JavaScript code, containing the OpenAPI client code for the web interface. | | `generate-py` | Generate the Python code, containing the OpenAPI client code for the Blender add-on. |
| `test` | Run the unit tests. | | `generate-js` | Generate the JavaScript code, containing the OpenAPI client code for the web interface. |
| `clean` | Remove build-time files. | | `test` | Run the unit tests. |
| `version` | Print some version numbers, mostly for debugging the Makefile itself. | | `clean` | Remove build-time files. |
| `list-embedded` | List the files embedded into the `flamenco-manager` executable. | | `version` | Print some version numbers, mostly for debugging the Makefile itself. |
| `list-embedded` | List the files embedded into the `flamenco-manager` executable. |
| `tools` | Download FFmpeg for all supported platforms. Can be suffixed by `-linux`, `-windows`, or `-darwin` to only download for specific platforms. |
| `release-package` | Builds release packages for all supported platforms. Can be suffixed by `-linux`, `-windows`, or `-darwin` to only build specific platforms. |
[race]: https://go.dev/doc/articles/race_detector [race]: https://go.dev/doc/articles/race_detector