Skip to content

Commit 011f0c4

Browse files
committed
Update documentation to include mac demo build
#1553
1 parent 7acb742 commit 011f0c4

5 files changed

+12
-2
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Users browse to the client app on the configured server port from a web browser,
2525

2626
In diagrammatic form this looks like the image below:
2727

28-
![omSupply Architecture drawio](./architecture.drawio.svg)
28+
![omSupply Architecture drawio](./doc/architecture.drawio.svg)
2929

3030
There are also several ancilliary applications as noted, which are available to be run (cli applications) or hosted (storybook) separately.
3131

@@ -46,4 +46,14 @@ Continue incrementing the test version as builds are done.
4646

4747
If you want to build your own branch, anything such as `v1.0.4-PR123-t1` will work great.
4848

49+
#### Demo builds
4950

51+
You can build a demo app for MacOS through actions: Run new workflow [from here](https://github.com/openmsupply/open-msupply/actions/workflows/build-mac-demo.yaml), this can take up to an hour
52+
53+
![Mac Buid Dispatch](./doc/mac_demo_workflow_dispatch.png)
54+
55+
Once the binary is compiled it should be available in the Artifacts of the action run: Find the [workflow run here](https://github.com/openmsupply/open-msupply/actions), then look at the Artifacts for that workflow run
56+
57+
![Mac Build Artifact](./doc/mac_demo_artifact.png)
58+
59+
[Further info](./build/mac/README.md)

build/mac/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`NOTE` -> this is for demo and testing purposes only, not to be used in production
44

55
```bash
6-
# for Intel mac
6+
# for Intel mac (also works on Arm mac)
77
./build/mac/build.sh intel
88
# or for Arm mac (with demo data)
99
./build/mac/build.sh arm true
File renamed without changes.

doc/mac_demo_artifact.png

14.1 KB
Loading

doc/mac_demo_workflow_dispatch.png

20.3 KB
Loading

0 commit comments

Comments
 (0)