summaryrefslogtreecommitdiffstats
path: root/packaging/macos/README.md
diff options
context:
space:
mode:
authorRené de Hesselle <dehesselle@web.de>2019-04-22 18:45:50 +0000
committerRené de Hesselle <dehesselle@web.de>2019-04-22 20:07:43 +0000
commitab482654696a3b6b5adfae95fffe45291199712d (patch)
tree3faf03e4a41cbf970edbd8ea69dce0aa3775836b /packaging/macos/README.md
parentPull in fix for stdout issues (diff)
downloadinkscape-ab482654696a3b6b5adfae95fffe45291199712d.tar.gz
inkscape-ab482654696a3b6b5adfae95fffe45291199712d.zip
Update macOS build pipeline
Highlights: - fixes open/save crashes - fixes localization - bundles Python 3, enabling extensions Also lots of internal improvements and refactoring.
Diffstat (limited to 'packaging/macos/README.md')
-rw-r--r--packaging/macos/README.md31
1 files changed, 12 insertions, 19 deletions
diff --git a/packaging/macos/README.md b/packaging/macos/README.md
index 4d2bf133d..866e88d79 100644
--- a/packaging/macos/README.md
+++ b/packaging/macos/README.md
@@ -4,26 +4,27 @@ This folder contains the scripts that make up the build pipeline for Inkscape on
## Requirements
+_It would've been more fair if this section was called "recommandations" instead, but that would only encourage carelessness._
+
- Use a __dedicated, clean macOS installation__ as build machine. "clean" as in "freshly installed + Xcode CLI tools". Nothing more, nothing less.
- Especially no MacPorts, no Fink, no Homebrew, ... because they could interfere with the build system we're using.
- macOS 10.13.6 with Xcode 10.1.
- - Other versions might work but haven't been tested.
+ - These scripts are being developed and used using said versions.
+ - Newer versions might work but haven't been tested.
- A full Xcode installation won't hurt, but is not required.
-
- __Use a dedicated user account__ unless you're prepared that these scripts will delete and overwrite your data in the following locations:
_(comments based on default configuration)_
```bash
- $HOME/.cache # will be symlinked to $HOME/work/tmp
- $HOME/.local # will be symlinked to $HOME/work/opt
+ $HOME/.cache # will be symlinked to $WRK_DIR/tmp
+ $HOME/.local # will be symlinked to $WRK_DIR/opt
$HOME/.profile # will be overwritten
- $HOME/Source # will be symlinked to $HOME/work/opt/src
```
- __16 GiB RAM__, since we're using a 10 GiB ramdisk to build everything.
- Using a ramdisk speeds up the process significantly and avoids wearing out your ssd.
- - You can choose to not use a ramdisk by overriding `RAMDISK_ENABLE=false` in a e.g. `011-custom.sh` file.
- - The build environment takes up ~6.5 GiB of disk space, the Inkscape Git repository ~1.8 GiB. Subject to change and YMMV.
+ - You can choose to not use a ramdisk by overriding `RAMDISK_ENABLE=false` in a e.g. `021-custom.sh` file.
+ - The build environment takes up ~6.1 GiB of disk space, the Inkscape Git repository ~1.6 GiB. Subject to change and YMMV.
- somewhat decent __internet connection__ for all the downloads
## Usage
@@ -42,16 +43,6 @@ This will run all the `nnn-*.sh` scripts consecutively.
### GitLab CI
-#### manual task: setup build environment
-
-For now, the CI pipeline is designed to be run on a persistent machine since it does not setup the required build environment itself. This is a manual task you have to perform beforehand by running
-
-```bash
-./create_buildenv.sh
-````
-
-This will setup the build environment in `$HOME/work` as a ramdisk.
-
#### configuration example `.gitlab-runner/config.toml`
```toml
@@ -68,10 +59,12 @@ This will setup the build environment in `$HOME/work` as a ramdisk.
```yaml
buildmacos:
+ before_script:
+ - packaging/macos/build_toolset.sh
script:
- - packaging/macos/210-inkscape.sh
+ - packaging/macos/build_inkscape.sh
```
## Status
-This is still a work in progress and actively being worked on. Use at your own risk.
+This is still a work in progress and actively being worked on.