diff --git a/README.md b/README.md index fe597d2..6906f76 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ Use this action to run your CI in NetBSD. The github workflow only supports Ubuntu, Windows and MacOS. But what if you need to use NetBSD? -This action is to support NetBSD. -Sample workflow `test.yml`: + +## 1. Example: `test.yml`: ```yml @@ -73,6 +73,10 @@ So, you will have the same directory and same default env variables when you `ru + + +## 2. Share code + The code is shared from the host to the VM via `rsync` by default, you can choose to use to `sshfs` share code instead. @@ -130,6 +134,7 @@ When using `rsync`, you can define `copyback: false` to not copy files back fro ``` +## 3. NAT from host runner to the VM You can add NAT port between the host and the VM. @@ -151,6 +156,8 @@ You can add NAT port between the host and the VM. ``` +## 4. Set memory and cpu + The default memory of the VM is 6144MB, you can use `mem` option to set the memory size: ``` @@ -184,6 +191,9 @@ The VM is using all the cpu cores of the host by default, you can use `cpu` opti ... ``` + +## 5. Select release + It uses [the NetBSD 10.0](conf/default.release.conf) by default, you can use `release` option to use another version of NetBSD: ``` @@ -202,6 +212,7 @@ All the supported releases are here: NetBSD 10.0, 9.0, 9.1, 9.2, 9.3, 9.4, test +## 6. Custom shell Support custom shell: