From 2dccfd195a7f2eb46a2527ef42cf5d3d35c62c3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Tue, 30 Aug 2022 15:23:59 +0200 Subject: [PATCH] Website: document how to get `make` This is now only written for Debian/Ubuntu and Windows, and not for other Linux flavours or macOS. Also the Windows documentation is very minimal, but at least contains the info I always tend to forget. --- .../development/getting-started/_index.md | 29 +++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/web/project-website/content/development/getting-started/_index.md b/web/project-website/content/development/getting-started/_index.md index 18a2a2e7..f0cd8e90 100644 --- a/web/project-website/content/development/getting-started/_index.md +++ b/web/project-website/content/development/getting-started/_index.md @@ -79,7 +79,32 @@ brew install yarn {{< /tab >}} {{< /tabs >}} -## 3. Your First Build +## 4. Utility Tools + +Building Flamenco requires only a few tools to be installed on your system. + + +{{< tabs "installing-utils" >}} +{{< tab "Linux" >}} +On Linux only `make` is necessary, which can be installed via your package manager. + +On Debian, and relatives like Ubuntu, run: + +``` +sudo apt install make +``` +{{< /tab >}} +{{< tab "Windows" >}} +Install [MingW W64][mingw]. If in doubt which version to get, grab the `686`/`seh` one. + +[mingw]: https://github.com/niXman/mingw-builds-binaries/releases +{{< /tab >}} +{{< tab "macOS" >}} +TODO: write this documentation. +{{< /tab >}} +{{< /tabs >}} + +## 4. Your First Build Run `make with-deps` to install build-time dependencies and build the application. Subsequent builds can just run `make` without arguments. @@ -92,7 +117,7 @@ enable the race condition checker, and all other kinds of useful things. [building]: {{< relref "../building/" >}} -## 4. Get Involved +## 5. Get Involved If you're interested in helping out with Flamenco development, please read [Get Involved!][get-involved]