You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Speedup and simplify docker build
- Fix compiler errors when building with clang-15
- Update readme on building with docker
- Minor reformatting (using existing `.clang-format` file)
Copy file name to clipboardExpand all lines: README.md
+28-2Lines changed: 28 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,9 +39,21 @@
39
39
40
40
LLVM/Clang are declared as a dependency in the project's `CMakeLists.txt` file, and will be downloaded and made available to the project automatically.
41
41
42
-
# Using Docker
42
+
# How to run from Docker
43
43
44
-
You may need to increase your docker resources to build the image.
44
+
```sh
45
+
docker pull ghcr.io/adobe/hyde:latest
46
+
47
+
docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)",target=/mnt/host \
48
+
--tty --interactive \
49
+
ghcr.io/adobe/hyde:latest bash
50
+
```
51
+
52
+
You can then run the examples as below, except don't prefix `hyde` with `./`.
53
+
54
+
# Building the Docker image
55
+
56
+
You may need to increase your docker resources to build the image. (2.0.1 successfully built with 16GB RAM and 4GB swap)
45
57
46
58
```sh
47
59
docker build --tag hyde .
@@ -51,6 +63,20 @@ docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)",target=/mnt
51
63
hyde bash
52
64
```
53
65
66
+
# Publishing the docker image (requires write access to the `adobe` GitHub organization)
67
+
68
+
Instructions for publishing a GitHub package can be found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
69
+
Instructions for associating the with the `adobe/hyde` repository can be found [here](https://docs.github.com/en/packages/learn-github-packages/connecting-a-repository-to-a-package#connecting-a-repository-to-a-container-image-using-the-command-line).
70
+
71
+
```sh
72
+
VERSION=2.0.1
73
+
docker tag hyde ghcr.io/adobe/hyde:$VERSION
74
+
docker tag hyde ghcr.io/adobe/hyde:latest
75
+
docker push ghcr.io/adobe/hyde:$VERSION
76
+
docker push ghcr.io/adobe/hyde:latest
77
+
```
78
+
79
+
54
80
# Parameters and Flags
55
81
56
82
There are several modes under which the tool can run:
0 commit comments