Skip to content

Commit 206bf93

Browse files
Merge pull request #3 from OUIsolutions/copilot/update-build-documentation
Update build documentation with Darwin 0.20+ requirements and new build commands
2 parents ac98a70 + b8efc58 commit 206bf93

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

docs/build_instructions.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33
### Build Requirements
44
#### Darwin
5-
For Build the project you must have [Darwin](https://github.com/OUIsolutions/Darwin) installed on version 0.2.1
5+
For Build the project you must have [Darwin](https://github.com/OUIsolutions/Darwin) installed on version 0.20 or later
66
if you are on linux you can install darwin with:
77

88
```bash
9-
curl -L https://github.com/OUIsolutions/Darwin/releases/download/0.2.1/darwin.c -o darwin.c &&
9+
curl -L https://github.com/OUIsolutions/Darwin/releases/download/0.20/darwin.c -o darwin.c &&
1010
gcc darwin.c -o darwin.out &&
1111
sudo mv darwin.out /usr/bin/darwin
12+
```
13+
14+
After installing Darwin, run the following command to install project dependencies:
15+
```bash
1216
darwin install
1317
```
1418

@@ -21,17 +25,27 @@ darwin run_blueprint build/ --mode folder local_build
2125
\```
2226
```
2327

24-
### Full Build from Docker or Podman
25-
You must have podman or docker installed on your machine to build in these way, you can set what you want to use on the [build/config.lua](/build/config.lua) file.
28+
### Building the Project
2629

27-
if you want to make a full build to all platforms you can use the following command, it will create the following files:
30+
To build all targets, use the following command:
2831
```bash
29-
darwin run_blueprint --target amalgamation zip
32+
darwin run_blueprint --target all
3033
```
3134

32-
Output files:
33-
- release/CWebStudioFirmware.c
34-
- release/CWebStudioFirmware.zip
35+
Alternatively, you can build specific targets by providing their names (following the recipes in the darwinconf.lua file):
36+
```bash
37+
darwin run_blueprint --target amalgamation
38+
darwin run_blueprint --target zip
39+
```
40+
41+
Available targets:
42+
- **amalgamation**: Creates a single amalgamated C file at `release/CWebStudioFirmware.c`
43+
- **zip**: Creates a zip archive at `release/CWebStudioFirmware.zip` containing dependencies, docs, build, and src folders
44+
45+
You can also build multiple specific targets at once:
46+
```bash
47+
darwin run_blueprint --target amalgamation zip
48+
```
3549

3650
### Build Configurations
3751
All build configurations are in the **build/config.lua** file.

0 commit comments

Comments
 (0)