Skip to content

Commit 578d900

Browse files
Updated README.md for tools directory.
1 parent 80b8197 commit 578d900

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

‎tools/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,15 @@ compile the package automatically if you run it on a FreeBSD system. Files are r
99
found in the `templates` subdirectory
1010

1111
### Usage
12-
`python3 tools/make_package.py`
12+
To build in-place on FreeBSD:
13+
`python3 tools/make_package.py --branch <BRANCH NAME TO TARGET> --tag <VERSION TO ASSIGN PACKAGE> --freebsd <FREEBSD VERSION>`
1314

15+
To build on a remote FreeBSD host using SSH/SCP:
16+
`python3 tools/make_package --remote --host <IP or HOSTNAME OF FREEBSD> --branch <BRANCH NAME TO TARGET> --tag <VERSION TO ASSIGN PACKAGE> --freebsd <FREEBSD VERSION>`
17+
18+
For example:
19+
`python3 tools/make_package --remote --host 192.168.1.25 --branch master --tag 0.0.4 --freebsd 12
20+
`
1421
### Dependencies
1522
- `Jinja2` package must be installed before running (`python3 -m pip install jinja2`)
1623

@@ -23,6 +30,8 @@ Command will output the FreeBSD make command output. Outputs the following files
2330
this should be located in the `pfsense-api/pfSense-pkg-API` directory after completion. On FreeBSD 12 it should be
2431
located in the `pfsense-api/pfSense-pkg-API/work/pkg` directory.
2532

33+
If you have run the script using the `--remote` flag, the built package will be copied to your local system using SCP.
34+
2635
### Notes
2736
- This script heavily depends on it's relative filepaths. You may execute the script from any directory, but do not move
2837
the script to another directory.

0 commit comments

Comments
 (0)